Ouranosinc / xclim

Library of derived climate variables, ie climate indicators, based on xarray.
https://xclim.readthedocs.io/en/stable/
Apache License 2.0
333 stars 59 forks source link

Numpydoc Compliance #1988

Open Zeitsperre opened 2 weeks ago

Zeitsperre commented 2 weeks ago

Pull Request Checklist:

What kind of change does this PR introduce?

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

review-notebook-app[bot] commented 2 weeks ago

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

github-actions[bot] commented 2 days ago

[!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.

Zeitsperre commented 2 days ago

@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!