gh-155228: Check the length of parameter descriptions in Argument Clinic - #155251
Open
ghostiee-11 wants to merge 2 commits into
Open
gh-155228: Check the length of parameter descriptions in Argument Clinic#155251ghostiee-11 wants to merge 2 commits into
ghostiee-11 wants to merge 2 commits into
Conversation
…nt Clinic
The docstring line width check ran before the {parameters} block was
substituted into the docstring, so parameter descriptions of any length
were accepted without a warning. This was a leftover of pythongh-150285, and
was easiest to miss for cloned functions, which inherit the parameter
descriptions of the function they clone.
Measure the rendered parameter description lines as part of the docstring
body, taking the indentation of the {parameters} marker into account, and
rewrap the 30 functions in the tree whose descriptions exceeded their
limit. The width warnings now also report the file they come from.
The issue lists 24 functions; the check reports 30. Three of the listed
functions (bytes.decode, bytearray.decode and winreg.ConnectRegistry) are
1 to 5 characters under their limit on this commit and are left unchanged.
ghostiee-11
requested review from
a team,
AA-Turner,
emmatyping,
erlend-aasland and
pablogsal
as code owners
August 5, 2026 16:16
|
Most changes to Python require a NEWS entry. Add one using the blurb_it web app or the blurb command-line tool. If this change has little impact on Python users, wait for a maintainer to apply the |
|
All commit authors signed the Contributor License Agreement. |
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
1 participant
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.
Measure parameter description lines in the docstring width check and rewrap the 30 functions in the tree that exceeded their limit.