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:
![image](https://user-images.githubusercontent.com/10444222/104784415-356be700-5756-11eb-8268-33d8f7fe5520.png)
Here's a screenshot after running docformatter:
![image](https://user-images.githubusercontent.com/10444222/104784481-61876800-5756-11eb-8eda-5bdf8db4fb21.png)
Note that the description was not line-wrapped.
Here's a screenshot after running docformatter with the --force-wrap option:
![image](https://user-images.githubusercontent.com/10444222/104784592-a01d2280-5756-11eb-9fe6-e6ad0c65c571.png)
Note that the description was line-wrapped but the Sphinx param was also wrapped.
The text was updated successfully, but these errors were encountered: