Skip to content

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

Merged
AA-Turner merged 9 commits into
python:mainfrom
AA-Turner:clinic/overlong-docstrings
Aug 12, 2025
Merged

GH-137623: Begin enforcing docstring length in Argument Clinic#137624
AA-Turner merged 9 commits into
python:mainfrom
AA-Turner:clinic/overlong-docstrings

Conversation

@AA-Turner

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

Copy link
Copy Markdown
Member

@bedevere-appbedevere-appBot mentioned this pull request Aug 11, 2025
Closed
serhiy-storchaka
serhiy-storchaka reviewed Aug 11, 2025
View reviewed changes

@serhiy-storchakaserhiy-storchaka 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.

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?

Comment threadTools/clinic/libclinic/errors.py Outdated
serhiy-storchaka
serhiy-storchaka reviewed Aug 12, 2025
View reviewed changes
Comment threadTools/clinic/libclinic/dsl_parser.py Outdated
Comment threadTools/clinic/libclinic/_overlong_docstrings.py
Comment threadTools/clinic/libclinic/errors.py Outdated
@skirpichevskirpichev 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
Comment threadTools/clinic/libclinic/function.py Outdated
@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

@serhiy-storchakaserhiy-storchaka 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.

LGTM. 👍

@AA-Turner
AA-Turner merged commit 6baf552 into python:mainAug 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 afterpython#137624
a4f7f0c
Agent-Hellboy pushed a commit to Agent-Hellboy/cpython that referenced this pull request Aug 19, 2025
@AA-Turner@Agent-Hellboy
pythonGH-137623: Begin enforcing docstring length in Argument Clinic (p…
ebd6126
…ython#137624)
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@serhiy-storchakaserhiy-storchakaserhiy-storchaka approved these changes
@erlend-aaslanderlend-aaslandAwaiting requested review from erlend-aaslanderlend-aasland is a code owner

Assignees

No one assigned

Labels

skip newstopic-argument-clinic

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@AA-Turner@serhiy-storchaka