Automatic wrapping and force wrapping issues #68
Labels
C: style
Relates to docstring format style (e.g., Google, NumPy, Sphinx)
P: enhancement
Feature that is outside the scope of PEP 257
Milestone
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:
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.
The text was updated successfully, but these errors were encountered: