roocs / clisops / 16154603223

87%

Build Type

push

github

Committed by web-flow

Commit Message

Fix docstrings and add more static typing to call signatures (#439)

### What kind of change does this PR introduce?: <!--(Bug fix, feature,
docs update, etc.)-->

* Replaces `black` and `isort` and most checks done via `flake8` with
`ruff`
* All docstrings that were previously written using non-`numpydoc`
conventions have been translated.
* Call signatures have been added for many functions missing them.
* `pre-commit` checks now include `ruff`, as well as several other new
hooks, including test artifact checking and YAML linting
* Coding conventions are now set for Python3.10+
* Added an `engine` argument for `Grid.ds.to_netcdf()`.

### Does this PR introduce a breaking change?: <!--(Has there been an
API change? New dependencies?)-->

Yes. Almost all docstrings have been modified, and call signatures have
been changed in many places. Some small bugs have been dealt with. This
represents an enormous change and the documentation should benefit from
this.

`Grid.ds.to_netcdf()` now accepts an `engine` argument (default: `None`)
to allow passing a specific engine option. This is necessary in some
situations (malformed metadata in a Dataset is better handled by
NetCDF4).

### Other information: <!--(Relevant discussion threads? Outside
documentation pages?)-->

`ruff` has been developed to provide a comprehensive set of linting and
formatting tools based on existing projects in Python. The program is
built in `rust` and is extremely fast.

The docstrings were converted using AI (GitHub Copilot) and human
validation. Corrections were made manually as needed.

Run Details

334 of 398 new or added lines in 28 files covered. (83.92%)

47 existing lines in 11 files now uncovered.

3096 of 3582 relevant lines covered (86.43%)

5.74 hits per line