Derived from the pydocstyle linter.
Fix is always available.
What it does#
Checks for docstring summary lines that are not positioned on the first physical line of the docstring.
Why is this bad?#
PEP 257 recommends that multi-line docstrings consist of "a summary line just like a one-line docstring, followed by a blank line, followed by a more elaborate description."
The summary line should be located on the first physical line of the docstring, immediately after the opening quotes.
This rule may not apply to all projects; its applicability is a matter of
convention. By default, this rule is enabled when using the
For an alternative, see D213.