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
The rule that checks missing documentation for parameters considers empty descriptions as undocumented (undocumented-param, DOC501).
We have a similar rule for exceptions, which considers empty descriptions as documented (docstring-missing-exception, D417).
The rule that checks missing documentation for parameters considers empty descriptions as undocumented (
undocumented-param
, DOC501).We have a similar rule for exceptions, which considers empty descriptions as documented (
docstring-missing-exception
, D417).This example only errors for DOC501:
ruff check --select D417,DOC501 --preview example.py
Proposal: modify D417 to report an error for empty exception descriptions.
Alternative solution: split
undocumented
andempty/missing
into two separate rules.This behaviour is especially useful when docstring stubs are auto-generated (#14492)
The text was updated successfully, but these errors were encountered: