-
Notifications
You must be signed in to change notification settings - Fork 81
Open
Labels
C: styleRelates to docstring format style (e.g., Google, NumPy, Sphinx)Relates to docstring format style (e.g., Google, NumPy, Sphinx)P: bugPEP 257 violation or existing functionality that doesn't work as documentedPEP 257 violation or existing functionality that doesn't work as documentedU: mediumA relatively medium urgency issueA relatively medium urgency issue
Description
I posted a comment in #243 but am not sure that will be seen since that issue is closed. I have
% docformatter --version
docformatter 1.7.5
and the fix from that issue appears to apply only to the first line and not to the description lines that follow, e.g.
% cat foo.py
def f():
"""
Here is a sufficiently long docstring first line with a ``word`` wrapped in backticks which will be wrapped as expected.
Here is a sufficiently long docstring description with a ``word`` wrapped in backticks which will not be wrapped as expected.
"""
pass
% docformatter foo.py
% cat foo.py
def f():
"""
Here is a sufficiently long docstring first line with a ``word`` wrapped in backticks which will
be wrapped as expected.
Here is a sufficiently long docstring description with a ``word`` wrapped in backticks which will not be wrapped as expected.
"""
pass
Is this intended / am I doing it wrong?
Here's my config block in pyproject.toml
:
[tool.docformatter]
black = true
in-place = true
make-summary-multi-line = true
pre-summary-newline = true
recursive = true
wrap-descriptions = 100
wrap-summaries = 100
Thanks in advance for any guidance, and thanks in general for this great tool!
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: bugPEP 257 violation or existing functionality that doesn't work as documentedPEP 257 violation or existing functionality that doesn't work as documentedU: mediumA relatively medium urgency issueA relatively medium urgency issue