Initial upgrade to "Code QA Sprint" standards

SciTools / iris-grib

GRIB interface for Iris.

https://iris-grib.readthedocs.io/

BSD 3-Clause "New" or "Revised" License

23 stars 43 forks source link

Initial upgrade to "Code QA Sprint" standards #564

Closed pp-mo closed 1 day ago

pp-mo commented 6 days ago

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

codecov-commenter commented 6 days ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 89.60%. Comparing base (d00965d) to head (0e2ea17). Report is 1 commits behind head on main.

Additional details and impacted files

```diff @@ 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 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

pp-mo commented 6 days ago

TODO

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

[x] additional disabled numpydocs-validation checks : remove some, where straightforward, with matching source changes
[ ] temporary disables in ./.ruff.toml : see if we can target some of these
[ ] still using mypy "strict=false" (but that one's probably too much work to fix at this point)

pp-mo commented 5 days ago

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 commented 5 days ago

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

pp-mo commented 1 day ago

Something odd here. I removed the temporary "Wild renames" commit from the branch on my fork, but Github doesn't pick up the 'backwards change', for some odd reason.

So I closed, but now it won't allow re-open.

Bear with while I try to sort it.
If necessary, I'll use a new branch name + new PR.