-
Notifications
You must be signed in to change notification settings - Fork 0
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
ci: Adds numpydoc-validation to pre-commit hooks #40
Conversation
This commit is added to `.git-blame-ignore-revs` so that the blame is not associated with the author.
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #40 +/- ##
==========================================
+ Coverage 65.87% 67.69% +1.82%
==========================================
Files 3 6 +3
Lines 337 452 +115
==========================================
+ Hits 222 306 +84
- Misses 115 146 +31 ☔ View full report in Codecov by Sentry. |
Co-authored-by: Sylvia Whittle <[email protected]>
@SylviaWhittle thanks for spotting my tpyo, corrected. The pre-commit.ci is failing but that is to be expected as it runs the new hook I'll tidy these up in a separate PR (most of them are simple and things like spacing before a colon in the docstring which makes it appear as though parameters aren't documented or starting description on a new line). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @ns-rse, this will help in slowly improving our code & documentation. I'll also endeavour to provide examples in docstrings when writing new functions.
Closes #39
numpydoc-validation
pre-commit hook.ruff
inpyproject.toml
.