Ouranosinc / xclim / 35261583179

91%

push

github

Fix indicator copy with some defaults - document registries (#2429)

<!--Please ensure the PR fulfills the following requirements! -->
<!-- If this is your first PR, make sure to add your details to the
AUTHORS.rst! -->
### Pull Request Checklist:
- [ ] This PR addresses an already opened issue (for bug fixes /
features)
    - This PR fixes #xyz
- [x] Tests for the changes have been added (for bug fixes / features)
- [x] (If applicable) Documentation has been added / updated (for bug
fixes / features)
- [ ] CHANGELOG.rst has been updated (with summary of main changes)
- [ ] Link to issue (:issue:`number`) and pull request (:pull:`number`)
has been added

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

* My bad, the test verifying that either the identifier is given or
register is False was not assuming that `register` is True by default,
this is fixed here.
* Also moved `copy` to `Indicator` and added default values for
`identifier` and `register`, properly documenting that at least one must
be given.
* Fixed the test accordingly.

Also, I realized the registries were not documented. This was harder
than I though because sphinx can't properly use the `autodata` directive
if the object is not referred by its exact path. So in order to use it,
we would need to refer the `registry` in the doc as
`xclim.core.indicator._indicator.registry`, although we want users to
use `xclim.core.indicator.regisry`. This is an old issue :
https://redirect.github.com/sphinx-doc/sphinx/issues/6495

The alternative was to put the documentation directly in the RST file.

### Does this PR introduce a breaking change?
No. It fixes one.

### Other information:

6 of 6 new or added lines in 1 file covered. (100.0%)

8100 of 8948 relevant lines covered (90.52%)

7.63 hits per line