Skip to content
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

doc(GroupTheory/Commensurable): clarify some docstrings #19127

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

kbuzzard
Copy link
Member


Open in Gitpod

I was trying to learn about commensurators from mathlib, but all the docstrings seemed to have been written for people who already knew what the definitions were. This wasn't hard to fix.

Copy link

PR summary ed44d87467

Import changes for modified files

No significant changes to the import graph

Import changes for all files
Files Import difference

Declarations diff

No declarations were harmed in the making of this PR! 🐙

You can run this locally as follows
## summary with just the declaration names:
./scripts/declarations_diff.sh <optional_commit>

## more verbose report:
./scripts/declarations_diff.sh long <optional_commit>

The doc-module for script/declarations_diff.sh contains some details about this script.


No changes to technical debt.

You can run this locally as

./scripts/technical-debt-metrics.sh pr_summary
  • The relative value is the weighted sum of the differences with weight given by the inverse of the current value of the statistic.
  • The absolute value is the relative value divided by the total sum of the inverses of the current values (i.e. the weighted average of the differences).

@github-actions github-actions bot added the t-algebra Algebra (groups, rings, fields, etc) label Nov 16, 2024
@kbuzzard kbuzzard added documentation Improvements or additions to documentation t-algebra Algebra (groups, rings, fields, etc) and removed t-algebra Algebra (groups, rings, fields, etc) labels Nov 16, 2024
Copy link
Collaborator

@adomani adomani left a comment

Choose a reason for hiding this comment

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

Thanks: this is much clearer!

bors d+

Comment on lines 46 to 47
@[to_additive "The index of a subgroup as a natural number,
and returns 0 if the index is infinite."]
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
@[to_additive "The index of a subgroup as a natural number,
and returns 0 if the index is infinite."]
@[to_additive "The index of a subgroup as a natural number.
Returns 0 if the index is infinite."]

I'm not sure that the suggestion will work, as it is outside of the modified lines.

@mathlib-bors
Copy link
Contributor

mathlib-bors bot commented Nov 16, 2024

✌️ kbuzzard can now approve this pull request. To approve and merge a pull request, simply reply with bors r+. More detailed instructions are available here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
delegated documentation Improvements or additions to documentation t-algebra Algebra (groups, rings, fields, etc)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants