Unexpected interaction with click rewrapping #291
Labels
C: stakeholder
Relates to docformatter stakeholder requested behavior
P: enhancement
Feature that is outside the scope of PEP 257
U: low
A relatively low urgency issue
Thank you for this project.
I am trying to get it to work with a CLI I maintain which uses Click.
Click generates help text for CLI commands from method docstrings.
Click rewraps text based on the width of the terminal, to a maximum of 80 characters.
In my case, this is not suitable as I have a long URL in a help text.
I therefore use Click's functionality to prevent rewrapping.
This involves using a
\b
escape marker.If we take the example in the Click documentation:
This renders as:
However,
docformatter
moves the\b
escape marker, so that the docstring is as so:This changes the rewrapping, so the help output is not as desired:
In my case, this breaks a link.
I have a workaround - to tell Click not to interpret the help text from the docstring. However, I hope that this can be resolved in
docformatter
.The text was updated successfully, but these errors were encountered: