Ouranosinc / xclim / 27216213287

92%

Build Type

push

github

Committed by web-flow

Commit Message

Fix maximum consecutive X days indicators (#2370)

### What kind of change does this PR introduce?
* Maximum consecutive dry or wet days
   +  Use `spell_length_statistics` instead of own code
    + Add an "op" argument to allow control of the comparison
    + Change the default to ">=/<=" to fit what the documentation says
+ Remove cryptic notes, seems over the top to explain this in a
mathematical way, and there were errors in the text
* Maximum warm, frost-free, frost days
+ in the indicators, use similar "XX_spell_max_length" index instead,
deprecate the indices

* Rewrite some standard names to put something that exists, even if it
doesn't fit 100% with the function.

### Does this PR introduce a breaking change?
* The comparison has changed in a few functions, by adding the "=="
case. This complies with the previous docstring.
* A few standard names and descriptions have changed.

Coverage Stats

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

3 existing lines in 1 file now uncovered.

7937 of 8643 relevant lines covered (91.83%)

6.27 hits per line