search

PyCQA / pydocstyle

docstring style checker
http://pydocstyle.org
MIT License
1.11k stars 188 forks source link

Google convention section names not properly checked #654

Open ziima opened 11 months ago

ziima commented 11 months ago

Google convention specifies docstring sections to be formatted as

Returns:
    The return value. True for success, False otherwise.

but pydocstyle doesn't report an error if section is formatted as

Returns: The return value. True for success, False otherwise.

D406 can't be used because it complains about the section name ending with a colon.