Skip to content

docformatter doesn't remove trailing whitespaces of header docstrings for sphinx-gallery #71

@seisman

Description

@seisman

docformatter can remove trailing whitespaces from the following script:

"""
A docstring with some invisible whitespace.     

More description with some invisible trailing whitespaces.   
"""

but does nothing to sphinx-gallery style header docstrings:

"""
A docstring with some invisible whitespace.     
=================================================

More description with some invisible trailing whitespaces.   
"""

Metadata

Metadata

Assignees

No one assigned

    Labels

    C: styleRelates to docstring format style (e.g., Google, NumPy, Sphinx)P: enhancementFeature that is outside the scope of PEP 257

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions