Repository navigation
python: state the order of docstring sections - #1073
Open
LubabaKhalid wants to merge 2 commits into
Open
LubabaKhalid wants to merge 2 commits into
LubabaKhalid wants to merge 2 commits into
Conversation
The examples always put Args before Returns/Yields and Raises last, but the text never says the order is expected. State it.
Contributor
Author
|
@vapier Could you review this PR when you have a chance? |
vapier
reviewed
Nov 4, 2026
Move the order into a dedicated paragraph and note that an Examples section, if used, comes before Args.
Contributor
Author
|
@nathanielmanistaatgoogle and @vapier Could you review this PR when you have a chance? |
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.
The examples always put
Args:beforeReturns:/Yields:andRaises:last, but the text never says this order is expected. As confirmed in the issue discussion, this adds a sentence stating the order.Fixes #847