Ouranosinc / xsdba / 16974153923

79%

push

github

Clearer error when `cluster_thresh` is too small in extremes (#184)

<!-- 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
- [ ] (If applicable) Documentation has been added / updated (for bug
fixes / features).
- [ ] (If applicable) Tests have been added.
- [x] CHANGELOG.rst has been updated (with summary of main changes).
- [x] Link to issue (:issue:`number`) and pull request (:pull:`number`)
has been added.

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

* ``xsdba.adjustment.ExtremeValues`` throws an error with a clear
message when the clustered precipitation exceed `1-q_thresh`. This
happens when `cluster_thresh` is too small (still in the bulk of the
distribution).

### Does this PR introduce a breaking change?

No

### Other information:

1 of 2 new or added lines in 1 file covered. (50.0%)

2785 of 3581 relevant lines covered (77.77%)

5.32 hits per line