[Merged by Bors] - doc: @[inherit_doc] on notations#9942
Closed
YaelDillies wants to merge 8 commits intomasterfrom
Closed
[Merged by Bors] - doc: @[inherit_doc] on notations#9942YaelDillies wants to merge 8 commits intomasterfrom
@[inherit_doc] on notations#9942YaelDillies wants to merge 8 commits intomasterfrom
Conversation
Make all the notations that unambiguously should inherit the docstring of their definition actually inherit it. Also write a few docstrings by hand. I only wrote the ones I was competent to write and which I was sure of. Some docstrings come from mathlib3 as they were lost during the early port. This PR is only intended as a first pass There are many more docstrings to add.
YaelDillies
commented
Jan 23, 2024
eric-wieser
reviewed
Jan 23, 2024
eric-wieser
reviewed
Jan 23, 2024
Member
|
Could you please fix merge conflict(s) and ping me on Zulip so that I review it before it rots again? |
urkud
reviewed
Jan 30, 2024
urkud
reviewed
Jan 30, 2024
Member
|
Otherwise LGTM. Thanks! |
Contributor
|
✌️ YaelDillies can now approve this pull request. To approve and merge a pull request, simply reply with |
Contributor
Author
|
bors merge |
mathlib-bors bot
pushed a commit
that referenced
this pull request
Jan 30, 2024
Make all the notations that unambiguously should inherit the docstring of their definition actually inherit it. Also write a few docstrings by hand. I only wrote the ones I was competent to write and which I was sure of. Some docstrings come from mathlib3 as they were lost during the early port. This PR is only intended as a first pass There are many more docstrings to add.
Contributor
|
Pull request successfully merged into master. Build succeeded: |
@[inherit_doc] on notations@[inherit_doc] on notations
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Make all the notations that unambiguously should inherit the docstring of their definition actually inherit it.
Also write a few docstrings by hand. I only wrote the ones I was competent to write and which I was sure of. Some docstrings come from mathlib3 as they were lost during the early port.
This PR is only intended as a first pass There are many more docstrings to add.