You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
maddenp-noaa opened this issue
Dec 18, 2023
· 1 comment
Labels
C: styleRelates to docstring format style (e.g., Google, NumPy, Sphinx)P: bugPEP 257 violation or existing functionality that doesn't work as documentedU: mediumA relatively medium urgency issue
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
weibullguy
added
P: bug
PEP 257 violation or existing functionality that doesn't work as documented
C: style
Relates to docstring format style (e.g., Google, NumPy, Sphinx)
and removed
fresh
This is a new issue
labels
Dec 21, 2023
C: styleRelates to docstring format style (e.g., Google, NumPy, Sphinx)P: bugPEP 257 violation or existing functionality that doesn't work as documentedU: mediumA relatively medium urgency issue
I posted a comment in #243 but am not sure that will be seen since that issue is closed. I have
and the fix from that issue appears to apply only to the first line and not to the description lines that follow, e.g.
Is this intended / am I doing it wrong?
Here's my config block in
pyproject.toml
:Thanks in advance for any guidance, and thanks in general for this great tool!
The text was updated successfully, but these errors were encountered: