-
Notifications
You must be signed in to change notification settings - Fork 86
Automatic wrapping and force wrapping issues #68
Copy link
Copy link
Closed
Labels
C: styleRelates to docstring format style (e.g., Google, NumPy, Sphinx)Relates to docstring format style (e.g., Google, NumPy, Sphinx)P: enhancementFeature that is outside the scope of PEP 257Feature that is outside the scope of PEP 257
Milestone
Description
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:

Here's a screenshot after running docformatter:

Note that the description was not line-wrapped.
Here's a screenshot after running docformatter with the --force-wrap option:

Note that the description was line-wrapped but the Sphinx param was also wrapped.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
C: styleRelates to docstring format style (e.g., Google, NumPy, Sphinx)Relates to docstring format style (e.g., Google, NumPy, Sphinx)P: enhancementFeature that is outside the scope of PEP 257Feature that is outside the scope of PEP 257