You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Argument Clinic currently requires that a summary line exists, but places no further restrictions on the content.
There are 32 instances of a docstring over 100 characters long, with the longest at 148 characters (_sre.SRE_Pattern.subn / re.Pattern.subn). Long lines like this become hard to read, for example in help or pydoc output.
I propose that we start enforcing a maximum length of 80 characters for new docstrings, but use a whitelist so that we don't need to change existing overly long docstrings (for now).
Feature or enhancement
Proposal:
Argument Clinic currently requires that a summary line exists, but places no further restrictions on the content.
There are 32 instances of a docstring over 100 characters long, with the longest at 148 characters (
_sre.SRE_Pattern.subn/re.Pattern.subn). Long lines like this become hard to read, for example inhelporpydocoutput.I propose that we start enforcing a maximum length of 80 characters for new docstrings, but use a whitelist so that we don't need to change existing overly long docstrings (for now).
A
cc @erlend-aasland @serhiy-storchaka
Has this already been discussed elsewhere?
This is a minor feature, which does not need previous discussion elsewhere
Links to previous discussion of this feature:
No response
Linked PRs