• Home
  • Features
  • Pricing
  • Docs
  • Announcements
  • Sign In

Ouranosinc / xclim / 12260894328
92%

Build:
DEFAULT BRANCH: main
Ran 10 Dec 2024 05:00PM UTC
Jobs 8
Files 73
Run time 4min
Badge
Embed ▾
README BADGES
x

If you need to use a raster PNG badge, change the '.svg' to '.png' in the link

Markdown

Textile

RDoc

HTML

Rst

10 Dec 2024 04:54PM UTC coverage: 89.387% (+0.01%) from 89.375%
12260894328

push

github

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

154 of 169 new or added lines in 33 files covered. (91.12%)

7 existing lines in 4 files now uncovered.

9433 of 10553 relevant lines covered (89.39%)

7.57 hits per line

Jobs
ID Job ID Ran Files Coverage
1 run-3.11-ubuntu-latest-standard - 12260894328.1 10 Dec 2024 05:08PM UTC 0
83.62
GitHub Action Run
2 run-3.10-ubuntu-latest-standard - 12260894328.2 10 Dec 2024 05:08PM UTC 0
81.72
GitHub Action Run
3 run-3.11-ubuntu-latest-py311-coverage-sbck-offline-prefetch - 12260894328.3 10 Dec 2024 05:08PM UTC 0
83.56
GitHub Action Run
4 run-3.10-ubuntu-latest-preliminary - 12260894328.4 10 Dec 2024 05:08PM UTC 0
81.72
GitHub Action Run
5 run-{{ matrix.python-version }}-conda - 12260894328.5 10 Dec 2024 05:08PM UTC 0
87.52
GitHub Action Run
6 run-3.12-ubuntu-latest-standard - 12260894328.6 10 Dec 2024 05:08PM UTC 0
82.09
GitHub Action Run
7 run-3.10-windows-latest-py310-coverage-prefetch - 12260894328.7 10 Dec 2024 05:08PM UTC 0
81.53
GitHub Action Run
8 run-3.11-macos-latest-py311-coverage-extras - 12260894328.8 10 Dec 2024 05:08PM UTC 0
87.49
GitHub Action Run
Source Files on build 12260894328
Detailed source file information is not available for this build.
  • Back to Repo
  • 1fc733d8 on github
  • Prev Build on main (#12247320924)
  • Next Build on main (#12261890650)
STATUS · Troubleshooting · Open an Issue · Sales · Support · CAREERS · ENTERPRISE · START FREE · SCHEDULE DEMO
ANNOUNCEMENTS · TWITTER · TOS & SLA · Supported CI Services · What's a CI service? · Automated Testing

© 2026 Coveralls, Inc