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:
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 (https://github.com/astral-sh/ruff/issues/14492)