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
avylove opened this issue
Aug 25, 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
def rgb_downconvert(self, red, green, blue):
"""
Translate an RGB color to a color code of the terminal's color depth.
:arg int red: RGB value of Red (0-255).
:arg int green: RGB value of Green (0-255).
:arg int blue: RGB value of Blue (0-255).
:rtype: int
:returns: Color code of downconverted RGB color
"""
Allowing Docformatter to fix it results in all the arguments running together
def rgb_downconvert(self, red, green, blue):
"""
Translate an RGB color to a color code of the terminal's color depth.
:arg int red: RGB value of Red (0-255). :arg int green: RGB value of Green (0-255). :arg int
blue: RGB value of Blue (0-255).
:rtype: int
:returns: Color code of downconverted RGB color
"""
Changing arg to param prevents it from being flagged
def rgb_downconvert(self, red, green, blue):
"""
Translate an RGB color to a color code of the terminal's color depth.
:param int red: RGB value of Red (0-255).
:param int green: RGB value of Green (0-255).
:param int blue: RGB value of Blue (0-255).
:rtype: int
:returns: Color code of downconverted RGB color
"""
However, arg is not flagged elsewhere in the file and is processed fine with autodoc
def move_yx(self, y, x):
"""
A callable string that moves the cursor to the given ``(y, x)`` screen coordinates.
:arg int y: vertical position, from top, *0*, to bottom of screen, *self.height - 1*.
:arg int x: horizontal position, from left, *0*, to right edge of screen, *self.width - 1*.
:rtype: ParameterizingString
:returns: Callable string that moves the cursor to the given coordinates
"""
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: style
Relates to docstring format style (e.g., Google, NumPy, Sphinx)
and removed
fresh
This is a new issue
labels
Aug 27, 2023
- fix for 'pylint: disable'
- pin docformatter, As it seems the bug that @avylove created may not
been addressed, freeze docformatter for now, to prevent failing CI
PyCQA/docformatter#264
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
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
The text was updated successfully, but these errors were encountered: