Skip to content

Option to not format module description docstring #126

@sammorley-short

Description

@sammorley-short

My organisation currently has a license header which doesn't conform to PEP 257, but I'd love to use docformatter for the rest of the module's contents.

I attempted to do this using the range option, but since the module description string also contains the module's description, one can know a minimum length for them, but not a maximum length.

It would be really great if docformatter had an option to toggle formatting of these module docstrings.

Thanks!

Metadata

Metadata

Assignees

No one assigned

    Labels

    C: stakeholderRelates to docformatter stakeholder requested behaviorP: enhancementFeature that is outside the scope of PEP 257U: lowA relatively low urgency issue

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions