4
92%
main: 92%

Ran 10 Dec 2024 05:08PM UTC

Files 73

Run time 3s

Badge

Embed ▾

Committed 10 Dec 2024 04:54PM UTC coverage: 81.721% (+0.02%) from 81.7%

Job # 12260894328.4

Build Type

push

github

Committed by

web-flow

Commit Message

Numpydoc Compliance (#1988)

### What kind of change does this PR introduce?

* Integrates the `numpydoc` library for docstring validation.
* Fixes the `codespell` configuration (previously was not parsing all
relevant files).
* Drops Python3.9 coding conventions everywhere.
* Reformats existing docstrings using `\*` to use `*` instead.
* On a related note, disabled `flake8`'s `RST210` and `RST213` checks
that were flagging `*` symbols in docstrings as unterminated *emphasis*
and **strong** tags.
* Adds a step to the `Indictor.parse_indice` that sanitizes the `*`
symbols from `Parameters` entries.
* Painstakingly modifies all docstrings to be closer to the `numpydoc`
specification.

### Does this PR introduce a breaking change?

It should not. Call signatures and docstrings will be slightly changed.

### Other information:

https://numpydoc.readthedocs.io/en/latest/validation.html

Except for the custom fields that we use to populate our documentation,
the docstrings of `xclim` are very consistent and virtually compliant
with the standard now.

Both `xclim.sdba` and `xclim.core.missing` are not evaluated by
`numpydoc` due to major refactoring efforts that are underway
(https://github.com/Ouranosinc/xsdba) or needed (#2000).

Run Details

8624 of 10553 relevant lines covered (81.72%)

0.82 hits per line

Ouranosinc / xclim / 12260894328 / 4
92%
main: 92%

README BADGES
x

Markdown

Textile

RDoc

HTML

Rst

Source Files on job run-3.10-ubuntu-latest-preliminary - 12260894328.4

Ouranosinc / xclim / 12260894328 / 4 92% main: 92%

README BADGES x

Markdown

Textile

RDoc

HTML

Rst

Source Files on job run-3.10-ubuntu-latest-preliminary - 12260894328.4

Ouranosinc / xclim / 12260894328 / 4
92%
main: 92%

README BADGES
x