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.

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

Merged
merged 4 commits into from
May 1, 2024

Conversation

ns-rse
Copy link
Collaborator

@ns-rse ns-rse commented Apr 30, 2024

Closes #39

ns-rse added 3 commits April 30, 2024 17:08
This commit is added to `.git-blame-ignore-revs` so that the blame is not associated with the author.
@ns-rse ns-rse added the ci Continuous Integration label Apr 30, 2024
@ns-rse ns-rse requested a review from SylviaWhittle April 30, 2024 16:44
@codecov-commenter
Copy link

codecov-commenter commented Apr 30, 2024

Codecov Report

Attention: Patch coverage is 91.66667% with 1 lines in your changes are missing coverage. Please review.

Project coverage is 67.69%. Comparing base (f282c31) to head (3c045c4).
Report is 103 commits behind head on main.

Files Patch % Lines
topofileformats/asd.py 91.66% 1 Missing ⚠️
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.
📢 Have feedback on the report? Share it here.

Co-authored-by: Sylvia Whittle <[email protected]>
@ns-rse
Copy link
Collaborator Author

ns-rse commented May 1, 2024

@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 numpydoc-validation against the main branch which includes your recently merged jpk/ibw/spm modules.

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).

Copy link
Collaborator

@SylviaWhittle SylviaWhittle left a 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.

@ns-rse ns-rse merged commit 84bfe52 into main May 1, 2024
9 of 10 checks passed
@ns-rse ns-rse deleted the ns-rse/39-numpydoc-validation branch May 1, 2024 21:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci Continuous Integration
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add numpydoc-validation to pre-commit checks
3 participants