python/pydoclint
Checks that each docstring names the arguments, return value, and exceptions of its function.
Part of the python configuration, at the recommended level. It runs at the commit stage, per file. It runs pydoclint.
A docstring that contradicts the signature misleads more than none, because people trust it.
What to do
Section titled “What to do”Bring the docstring in line with the signature.
Example
Section titled “Example”A docstring that documents name for a function that takes path reports a mismatch. Document path instead.
Turn it off
Section titled “Turn it off”Turn it off for some files, with a reason:
gspot ignore python/pydoclint --paths "<glob>" --reason "<why>"