-
Notifications
You must be signed in to change notification settings - Fork 17
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.
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
Add pylint docstrings to precommit hook #113
Comments
@bwohlberg Can I take this up ? I'd love to contribute to the repository and this seems like a nice "good first issue". I'll make changes to the |
Thanks @SauravMaheshkar, that would be great. |
Request for clarification: @bwohlberg In which section should I add |
The only existing reference I can find to the pre-commit hook is in point 9. of Installing a Development Version, so the minimal change necessary for consistency would seem to simply involve adding a mention of @Michael-T-McCann: Any additional thoughts on this? |
Unfortunately, the solution in #141 seems to run pylint on every file in the commit, including files that are normally skipped when running |
Note also the |
We current check for docstrings on PRs, but it would be nice to have this checked client-side as part of the precommit hook. This would also involve changing the dev requirements and updating the docs.
The text was updated successfully, but these errors were encountered: