-
Notifications
You must be signed in to change notification settings - Fork 2
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 Validation Hooks For Docstrings (Numpydocs) And Spelling (Typos) #106
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #106 +/- ##
==========================================
+ Coverage 91.48% 92.01% +0.53%
==========================================
Files 33 34 +1
Lines 634 664 +30
==========================================
+ Hits 580 611 +31
+ Misses 54 53 -1
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
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.
Looks great! A few minor changes. Thanks for the heavy lift, @AFg6K7h4fhy2!
Co-authored-by: George G. Vega Yon <g.vegayon@gmail.com>
I just fixed a handful of things, @AFg6K7h4fhy2. We are good to go once checks pass. |
The error in |
Add the
pre-commit
hooks fornumpydocs
(validationnumpy
style docstrings) andtypos
(finding spelling errors). As part of this, 2 config files were added:_typos.toml
and a section in./model/pyproject.toml
fornumpydocs
. To havenumpydocs
work successfully, there were small edits made across many files.The final
_typos.toml
:The final
numpydocs
checks: