Skip to content

Inconsistent docstring line lengths #4968

Open
@dabacon

Description

@dabacon

A few years ago we switched to using black to auto-format and set the character width at 100. When we did this, we ended up with a lot of doc strings that were not touched and so are 80 characters. We now have both 80 or 100 or a mixture of docstrings.

  1. Would be nice to just standardize on one width going forward, just so we don't have to think about it. Possibly also say new docstring follow this, old ones are ok.

  2. We could use a docstring format enforcer. The best I've found so far is https://github.com/PyCQA/docformatter . It is not super aggressive, if your description in a doc string has special characters, it prefers not to wrap things.

Low priority.

Metadata

Metadata

Assignees

No one assigned

    Labels

    area/cleancodearea/docstringskind/healthFor CI/testing/release process/refactoring/technical debt itemstriage/acceptedA consensus emerged that this bug report, feature request, or other action should be worked on

    Type

    No type

    Projects

    Status

    No status

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions