Derived from the pydocstyle linter.
What it does#
Checks for docstring first lines that are not in an imperative mood.
Why is this bad?#
PEP 257 recommends that the first line of a docstring be written in the imperative mood, for consistency.
Hint: to rewrite the docstring in the imperative, phrase the first line as if it were a command.
This rule may not apply to all projects; its applicability is a matter of
convention. By default, this rule is enabled when using the
pep257 conventions, and disabled when using the