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

Initial upgrade to "Code QA Sprint" standards #564

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

pp-mo
Copy link
Member

@pp-mo pp-mo commented Nov 13, 2024

Updated pre-commit config, to be compared with recommendations in "Scitools Code Quality Bonanza" project

@codecov-commenter
Copy link

codecov-commenter commented Nov 13, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.60%. Comparing base (d00965d) to head (d6d581e).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #564   +/-   ##
=======================================
  Coverage   89.60%   89.60%           
=======================================
  Files           8        8           
  Lines        2473     2473           
  Branches      420      420           
=======================================
  Hits         2216     2216           
  Misses        159      159           
  Partials       98       98           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@pp-mo
Copy link
Member Author

pp-mo commented Nov 13, 2024

TODO

Heads-up for what isn't here, to be addressed next (or ruled out-of-scope for the Code-QA sprint project) :

@pp-mo pp-mo marked this pull request as draft November 14, 2024 10:00
@pp-mo
Copy link
Member Author

pp-mo commented Nov 14, 2024

Fixed up to a point, probably a reasonable starting position.
The remaining numpydocs checks which we'd like to enable are the following :

$ pre-commit run numpydoc-validation --all-files | grep -oE "\| *[[:alpha:]]+[[:digit:]]+ *\|" | sort | uniq -c` 
     70 | GL08    |
    119 | PR01    |
     55 | RT01    |

with the meanings

check #occurs meaning
GL08 70 The object does not have a docstring
PR01 119 Parameters { ... } not documented
RT01 55 No Returns section found

@pp-mo pp-mo marked this pull request as ready for review November 14, 2024 16:52
@pp-mo
Copy link
Member Author

pp-mo commented Nov 14, 2024

Rebased following update for dependabot changes.
I think rebased is easier to look at.
Anyway, you should consider the last commit separately @ukmo-ccbunney (!)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants