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
AntoineD opened this issue
Apr 21, 2023
· 2 comments
· Fixed by #177
Labels
C: styleRelates to docstring format style (e.g., Google, NumPy, Sphinx)P: bugPEP 257 violation or existing functionality that doesn't work as documented
If a class docstring contains a line that is too long and cannot be reformatted, passing flake8 can be done by appending a #noqa to the docstring.
The following was not modified with docformatter 1.5.1 and black when triggered by pre-commit:
classC:
"""Class."""#noqaattr: int"""Attr."""
With docformatter 1.6.1, this is changed to:
classC:
"""Class."""#noqaattr: int"""Attr."""
and pre-commit always fails because docformatter and black both apply opposite changes.
This behavior is triggered by the comment appended to the docstring.
The text was updated successfully, but these errors were encountered:
weibullguy
added
P: bug
PEP 257 violation or existing functionality that doesn't work as documented
C: convention
Relates to docstring format convention
C: style
Relates to docstring format style (e.g., Google, NumPy, Sphinx)
and removed
fresh
This is a new issue
C: convention
Relates to docstring format convention
labels
Apr 22, 2023
Well, if I hadn't forgotten to git pull on the master branch after merging the PR that fixed this problem, it would've been part of v1.6.1! 🤦🏻♂️ I just released v1.6.2 with this fix.
C: styleRelates to docstring format style (e.g., Google, NumPy, Sphinx)P: bugPEP 257 violation or existing functionality that doesn't work as documented
If a class docstring contains a line that is too long and cannot be reformatted, passing flake8 can be done by appending a
#noqa
to the docstring.The following was not modified with
docformatter
1.5.1 andblack
when triggered bypre-commit
:With
docformatter
1.6.1, this is changed to:and
pre-commit
always fails becausedocformatter
andblack
both apply opposite changes.This behavior is triggered by the comment appended to the docstring.
The text was updated successfully, but these errors were encountered: