Skip to content
This repository has been archived by the owner on Nov 3, 2023. It is now read-only.

Google convention section names not properly checked #654

Open
ziima opened this issue Sep 21, 2023 · 0 comments
Open

Google convention section names not properly checked #654

ziima opened this issue Sep 21, 2023 · 0 comments

Comments

@ziima
Copy link

ziima commented Sep 21, 2023

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.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant