Replies: 2 comments
-
Can you tell me a bit more? I must be missing something important because I'm unable to reproduce this in our playground. I understand that you use an |
Beta Was this translation helpful? Give feedback.
0 replies
-
Sorry, I should have double-checked. The error was flagged by pydoclint, and not ruff. |
Beta Was this translation helpful? Give feedback.
0 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
-
I use
assert
s to check for post-conditions in my functions. I am also using Google docstrings to document those functions. Doing so, the ruff linter complains if I don't document theAssertionError
in the docstring. However, theassert
is not part of the API; it is a development tool that may be skipped during production. The Google Python Style Guide itself shows example of this here.Is there a way to configure
ruff
to ignore AssertionError in Google docstring, or even actually flag the presence of AssertionErrors in the docstring? I am usingDOC
, and ignoringDOC501
would skip checks on all exceptions, which is not what I want.Beta Was this translation helpful? Give feedback.
All reactions