Skip to content
This repository has been archived by the owner on Dec 16, 2022. It is now read-only.

DAR202 throws false positive excess returns #205

Open
JulianOrteil opened this issue Aug 23, 2022 · 0 comments
Open

DAR202 throws false positive excess returns #205

JulianOrteil opened this issue Aug 23, 2022 · 0 comments

Comments

@JulianOrteil
Copy link

JulianOrteil commented Aug 23, 2022

Sphinx Docstring Style:

"""Called when :py:meth:`~mymod.MyClass.my_method` raises an error.

The scheduler uses the output of this method to determine
whether the command should be immediately interrupted.

:param exc_type: The type of exception raised.
:type exc_type: :py:class:`Type`
:param exc: The exception raised.
:type exc: :py:class:`Exception`
:param traceback: The frame traceback of the error.
:type traceback: :py:class:`Traceback`

:return: `True` to indicate the error is handled. All other
    returns to the scheduler will be interpreted as the command
    needing to be immediately interrupted.
:rtype: bool
"""

CLI Output:
DAR202 Excess "Returns" in Docstring: + return

I believe it is picking up on my "returns to the scheduler" statement.

@JulianOrteil JulianOrteil changed the title DAR202 throws false position excess returns DAR202 throws false positive excess returns Aug 23, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant