Skip to content

Fixed documentation for common families #191

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Aug 30, 2023

Conversation

janbridley
Copy link
Collaborator

Description

A few of the families defined in #177 have messy documentation that result from missing line breaks. This has been addressed, and the short docstrings (which display in the Classes table on readthedocs) have been made more uniform.

Types of Changes

  • Documentation update
  • Bug fix
  • New feature
  • Breaking change1

1The change breaks (or has the potential to break) existing functionality.

Checklist:

  • I am familiar with the Contributing Guidelines.
  • I agree with the terms of the Contributor Agreement.
  • The changes introduced by this pull request are covered by existing or newly introduced tests.
  • I have updated the changelog and the credits.
    These changes fix a PR that I authored, so I have not modified the changelog.

@janbridley janbridley self-assigned this Aug 30, 2023
@codecov
Copy link

codecov bot commented Aug 30, 2023

Codecov Report

Merging #191 (0823466) into master (6e5331d) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #191   +/-   ##
=======================================
  Coverage   54.78%   54.78%           
=======================================
  Files          26       26           
  Lines        2621     2621           
=======================================
  Hits         1436     1436           
  Misses       1185     1185           
Files Changed Coverage Δ
coxeter/families/common.py 32.14% <ø> (ø)

@janbridley janbridley marked this pull request as ready for review August 30, 2023 14:07
@janbridley janbridley requested review from a team and DomFijan August 30, 2023 14:07
Copy link
Contributor

@DomFijan DomFijan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, Some of the name docs don't render properly (at least they are not in line with how others look). I think you are missing an empty line. Once this is fixed this is ready.

@janbridley janbridley enabled auto-merge (squash) August 30, 2023 19:40
@janbridley janbridley merged commit 0003c85 into master Aug 30, 2023
@janbridley janbridley deleted the fix-families-documentation branch August 30, 2023 21:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants