Open Zeitsperre opened 2 weeks ago
Check out this pull request on
See visual diffs & provide feedback on Jupyter Notebooks.
Powered by ReviewNB
[!NOTE] It appears that this Pull Request modifies the
main.yml
workflow.
On inspection, the XCLIM_TESTDATA_BRANCH
environment variable is set to the most recent tag (v2024.8.23
).
No further action is required.
@coxipi I just want to update the CHANGELOG one last time, but otherwise, this PR is simply waiting on the fix to support the latest xarray
.
Thanks again for your comments!
Pull Request Checklist:
number
) and pull request (:pull:number
) has been addedWhat kind of change does this PR introduce?
numpydoc
library for docstring validation.codespell
configuration (previously was not parsing all relevant files).\*
to use*
instead.flake8
'sRST210
andRST213
checks that were flagging*
symbols in docstrings as unterminated emphasis and strong tags.Indictor.parse_indice
that sanitizes the*
symbols fromParameters
entries.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
andxclim.core.missing
are not evaluated bynumpydoc
due to major refactoring efforts that are underway (https://github.com/Ouranosinc/xsdba) or needed (#2000).