Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Argument Clinic: Enforce summary line length #137623

Copy link
Copy link
@AA-Turner

Description

@AA-Turner
Issue body actions

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 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).

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

Reactions are currently unavailable

Metadata

Metadata

Assignees

No one assigned
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions

      Morty Proxy This is a proxified and sanitized view of the page, visit original site.