Align functools.reduce() docstring with PEP-257 #126045
Merged
Conversation
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
PEP 257 says that "Multi-line docstrings consist of a summary line just like a one-line docstring, followed by a blank line, followed by a more elaborate description." This is also a requirement from the Argument Clinic.
|
docstring changes from #125999 |
Actually in this case, I think we should keep the exiting formatting. Note that spaces around operators is no strict PEP-8 requirement; you may omit them for readability. |
I could have sworn it was. TIL! |
Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
willingc
approved these changes
Oct 28, 2024
Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
erlend-aasland
approved these changes
Oct 29, 2024
This comment was marked as outdated.
This comment was marked as outdated.
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
Oct 29, 2024
Yak-shave in preparation for Argument Clinic adaption in pythongh-125999. (cherry picked from commit 9b14083) Co-authored-by: Sergey B Kirpichev <skirpichev@gmail.com>
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
Oct 29, 2024
Yak-shave in preparation for Argument Clinic adaption in pythongh-125999. (cherry picked from commit 9b14083) Co-authored-by: Sergey B Kirpichev <skirpichev@gmail.com>
|
GH-126113 is a backport of this pull request to the 3.13 branch. |
|
GH-126114 is a backport of this pull request to the 3.12 branch. |
erlend-aasland
pushed a commit
that referenced
this pull request
Oct 29, 2024
erlend-aasland
pushed a commit
that referenced
this pull request
Oct 29, 2024
picnixz
pushed a commit
to picnixz/cpython
that referenced
this pull request
Dec 8, 2024
Yak-shave in preparation for Argument Clinic adaption in pythongh-125999.
ebonnal
pushed a commit
to ebonnal/cpython
that referenced
this pull request
Jan 12, 2025
Yak-shave in preparation for Argument Clinic adaption in pythongh-125999.
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.
PEP 257 says that "Multi-line docstrings consist of a summary line just like a one-line docstring, followed by a blank line, followed by a more elaborate description." This is also a requirement from the Argument Clinic.