Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Use pydocstyle to force pedantism on our docstrings via precommit hook #87

Open
rluce opened this issue Jun 2, 2023 · 1 comment
Open

Use pydocstyle to force pedantism on our docstrings via precommit hook #87

rluce opened this issue Jun 2, 2023 · 1 comment

Comments

@rluce
Copy link
Member

rluce commented Jun 2, 2023 •
edited
Loading

https://www.pydocstyle.org/en/6.3.0/usage.html

Maybe later ... for now it's a wall of warnings, e.g.:

 D401: First line should be in imperative mood; try rephrasing (found 'This')

Originally posted by @simonbowly in #86 (comment)
@simonbowly
Copy link
Member

So much potential for pedantism, so little time ...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@rluce @simonbowly