-
Notifications
You must be signed in to change notification settings - Fork 86
Inconsistent behavior with :arg syntax #264
Copy link
Copy link
Closed
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
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
Type
Fields
Give feedbackNo fields configured for issues without a type.
Seeing some inconsistent behavior in docformatter 1.7.5.
Docformatter 1.7.5 (Last successful CI used 1.7.3)
CPython 3.11
Example file: https://github.com/jquast/blessed/blob/a34c6b1869b4dd467c6d1ab6895872bb72db7e0f/blessed/terminal.py
Docformatter flags the following
Allowing Docformatter to fix it results in all the arguments running together
Changing arg to param prevents it from being flagged
However, arg is not flagged elsewhere in the file and is processed fine with autodoc