python/placeholder-docstrings
Finds docstrings that hold a placeholder word, or the name of the function again.
Part of the python configuration, at the all level. It runs at the commit stage, once per scope. gspot runs this check itself.
A docstring that says nothing satisfies the lint rule and wastes the line.
What to do
Section titled “What to do”Say what the function does that its name does not, or for whom it exists.
Example
Section titled “Example”A docstring that only repeats the function name reports a placeholder. Describe the behavior, inputs, and effects that the name leaves out.
Turn it off
Section titled “Turn it off”Turn it off for some files, with a reason:
gspot ignore python/placeholder-docstrings --paths "<glob>" --reason "<why>"