-
Notifications
You must be signed in to change notification settings - Fork 310
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 spelling and docstring enforcement #1147
Conversation
Codecov ReportBase: 80.07% // Head: 80.01% // Decreases project coverage by
Additional details and impacted files@@ Coverage Diff @@
## main #1147 +/- ##
==========================================
- Coverage 80.07% 80.01% -0.07%
==========================================
Files 68 68
Lines 8062 8062
Branches 1600 1600
==========================================
- Hits 6456 6451 -5
- Misses 1183 1186 +3
- Partials 423 425 +2
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report at Codecov. |
Based on reading Boring Python: code quality, adding two more checkers: sphinxcontrib-spelling, and interrogate for docstring enforcement, and adding a few more builtin pre-commit checkers.
I'm putting
validate-pyproject
andcheck-wheel-contents
into thecheck-python
script injupyter-releaser
to centralize those. I triedpyroma
but it assumessetuptools
is used.Most of the changes are adding docstrings to modules, classes, and methods.