Skip to content

Automatic wrapping and force wrapping issues #68

@thebuzzstop

Description

@thebuzzstop

Long descriptions are not being wrapped as expected.

When I use the --force-wrap option the entire docstring is properly wrapped but a Sphinx param is also wrapped which is undesirable.

Usage:

  • docformatter v1.4 inside PyCharm
  • invoked as an external tool with the following command line
  • docformatter --force-wrap --wrap-descriptions 72 --wrap-summaries 79 --in-place --range 1014 1019 myfile.py

Here's a screenshot of the before:
image

Here's a screenshot after running docformatter:
image
Note that the description was not line-wrapped.

Here's a screenshot after running docformatter with the --force-wrap option:
image
Note that the description was line-wrapped but the Sphinx param was also wrapped.

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