Skip to content

GH-137623: Begin enforcing docstring length in Argument Clinic #137624

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 9 commits into from
Aug 12, 2025
Merged

GH-137623: Begin enforcing docstring length in Argument Clinic #137624

merged 9 commits into from
Aug 12, 2025
+355 −12

Conversation

AA-Turner
Copy link
Member

@AA-Turner AA-Turner commented Aug 11, 2025 •
edited by bedevere-app bot
Loading

@bedevere-app bedevere-app bot mentioned this pull request Aug 11, 2025
Open
serhiy-storchaka
serhiy-storchaka reviewed Aug 11, 2025
View reviewed changes
Copy link
Member

@serhiy-storchaka serhiy-storchaka left a comment

Choose a reason for hiding this comment

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

I think that we should check the length for all lines, not only the first one. And the limit should be 72 for functions, __new__ and __init__, and 68 for other methods.

Also, should this be an error or warning?

serhiy-storchaka
serhiy-storchaka reviewed Aug 12, 2025
View reviewed changes
@skirpichev skirpichev mentioned this pull request Aug 12, 2025
Merged
@AA-Turner AA-Turner enabled auto-merge (squash) August 12, 2025 19:05
serhiy-storchaka
serhiy-storchaka reviewed Aug 12, 2025
View reviewed changes
@AA-Turner AA-Turner disabled auto-merge August 12, 2025 19:38
@AA-Turner AA-Turner enabled auto-merge (squash) August 12, 2025 19:52
serhiy-storchaka
serhiy-storchaka approved these changes Aug 12, 2025
View reviewed changes
Copy link
Member

@serhiy-storchaka serhiy-storchaka left a comment

Choose a reason for hiding this comment

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

LGTM. 👍

@AA-Turner AA-Turner merged commit 6baf552 into python:main Aug 12, 2025
54 checks passed
@AA-Turner AA-Turner deleted the clinic/overlong-docstrings branch August 12, 2025 20:21
skirpichev added a commit to skirpichev/cpython that referenced this pull request Aug 13, 2025
@skirpichev
adjust docstrings after python#137624
a4f7f0c
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@serhiy-storchaka serhiy-storchaka serhiy-storchaka approved these changes

@erlend-aasland erlend-aasland Awaiting requested review from erlend-aasland erlend-aasland is a code owner

Assignees
No one assigned
Labels
skip news topic-argument-clinic
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@AA-Turner @serhiy-storchaka