FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

Align functools.reduce() docstring with PEP-257 by skirpichev · Pull Request #126045 · python/cpython · GitHub

  1. python
  2. cpython

Repository navigation

Align functools.reduce() docstring with PEP-257 - #126045

Merged
erlend-aasland merged 5 commits into
python:mainfrom
skirpichev:reduce-docstring
Oct 29, 2024
ConversationCommits (5)ChecksFiles changed
Merged

Align functools.reduce() docstring with PEP-257#126045
erlend-aasland merged 5 commits into
python:mainfrom
skirpichev:reduce-docstring

Conversation

skirpichev commented Oct 27, 2024

Copy link
Copy Markdown
Member

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.

Improve functools.reduce() docstring
a22cef9 
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.

skirpichev commented Oct 27, 2024

Copy link
Copy Markdown
Member Author

docstring changes from #125999

skirpichev mentioned this pull request Oct 27, 2024
Merged
erlend-aasland reviewed Oct 27, 2024
View reviewed changes

erlend-aasland left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Thanks for making this a separate change, Sergey.

Comment thread Lib/functools.py Outdated
Comment thread Modules/_functoolsmodule.c Outdated
erlend-aasland changed the title Improve functools.reduce() docstring Align functools.reduce() docstring with PEP-257 Oct 27, 2024
erlend-aasland added needs backport to 3.12 only security fixes needs backport to 3.13 only security fixes labels Oct 27, 2024
ZeroIntensity reviewed Oct 27, 2024
View reviewed changes

ZeroIntensity left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Spaces around operators :)

Comment thread Modules/_functoolsmodule.c
Comment thread Lib/functools.py

erlend-aasland commented Oct 27, 2024

Copy link
Copy Markdown
Contributor

Spaces around operators :)

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.

ZeroIntensity commented Oct 27, 2024

Copy link
Copy Markdown
Member

Note that spaces around operators is no strict PEP-8 requirement

I could have sworn it was. TIL!

rhettinger removed their request for review October 28, 2024 01:45
skirpichev and others added 2 commits October 28, 2024 07:26
Apply suggestions from code review
ea5ae96 
Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
Merge branch 'main' into reduce-docstring
c0e7786
erlend-aasland reviewed Oct 28, 2024
View reviewed changes
Comment thread Lib/functools.py Outdated
willingc approved these changes Oct 28, 2024
View reviewed changes
Comment thread Lib/functools.py Outdated
Update Lib/functools.py
fed4911 
Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
erlend-aasland reviewed Oct 29, 2024
View reviewed changes
Comment thread Modules/_functoolsmodule.c Outdated
erlend-aasland enabled auto-merge (squash) October 29, 2024 07:44
erlend-aasland merged commit 9b14083 into python:main Oct 29, 2024

This comment was marked as outdated.

Sign in to view
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Oct 29, 2024
Align functools.reduce() docstring with PEP-257 (pythonGH-126045)
78e59af 
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
Align functools.reduce() docstring with PEP-257 (pythonGH-126045)
112730d 
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>

bedevere-app Bot commented Oct 29, 2024

Copy link
Copy Markdown

GH-126113 is a backport of this pull request to the 3.13 branch.

bedevere-app Bot removed the needs backport to 3.13 only security fixes label Oct 29, 2024

bedevere-app Bot commented Oct 29, 2024

Copy link
Copy Markdown

GH-126114 is a backport of this pull request to the 3.12 branch.

bedevere-app Bot removed the needs backport to 3.12 only security fixes label Oct 29, 2024
skirpichev deleted the reduce-docstring branch October 29, 2024 08:11
erlend-aasland pushed a commit that referenced this pull request Oct 29, 2024
[3.13] Align functools.reduce() docstring with PEP-257 (GH-126045) (#…
e7c6310 
…126113)

Yak-shave in preparation for Argument Clinic adaption in gh-125999.

(cherry picked from commit 9b14083)

Co-authored-by: Sergey B Kirpichev <skirpichev@gmail.com>
erlend-aasland pushed a commit that referenced this pull request Oct 29, 2024
[3.12] Align functools.reduce() docstring with PEP-257 (GH-126045) (#…
a8472fd 
…126114)

Yak-shave in preparation for Argument Clinic adaption in gh-125999.

(cherry picked from commit 9b14083)

Co-authored-by: Sergey B Kirpichev <skirpichev@gmail.com>
picnixz pushed a commit to picnixz/cpython that referenced this pull request Dec 8, 2024
Align functools.reduce() docstring with PEP-257 (python#126045)
5e75d4d 
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
Align functools.reduce() docstring with PEP-257 (python#126045)
c3664b4 
Yak-shave in preparation for Argument Clinic adaption in pythongh-125999.
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
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

ZeroIntensity ZeroIntensity left review comments
willingc willingc approved these changes
erlend-aasland erlend-aasland approved these changes

Assignees

No one assigned

Labels

skip issue skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

Back | FazBrowse Home | New Git URL