Repository navigation
Documented and standardize "private" or "internal use only" methods w… - #2153
Open
stevepiercy wants to merge 6 commits into
Open
stevepiercy wants to merge 6 commits into
stevepiercy wants to merge 6 commits into
Conversation
…ith Sphinx ``:meta private:`` field flag. - If a private method already had a docstring, inserted the flag. Else did nothing. - If an ``__init__`` method contained docstrings, merged it with its class. - Added missing Parameters section as needed. - Added "Required." flag as needed. - Sorted parameters as needed. Closes #1711
Contributor
|
Thanks for the pull request, @stevepiercy! A maintainer will review it shortly. |
stevepiercy
marked this pull request as draft
November 19, 2026 07:06
This was referenced Nov 19, 2026
stevepiercy
marked this pull request as ready for review
November 20, 2026 13:01
stevepiercy
enabled auto-merge (squash)
November 20, 2026 13:02
This branch has not been deployed
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
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.
…ith Sphinx
:meta private:field flag.Linked issue
Closes #1711
Description
__init__method contained docstrings, merged it with its class.Blocked by: