Ouranosinc / xclim / 34614329745

91%

Build Type

push

github

Committed by web-flow

Commit Message

Indicators return Datasets - flip option `as_dataset` to True (#2414)

<!--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:
- [x] This PR addresses an already opened issue (for bug fixes /
features)
    - This PR fixes #2410 
- [x] Tests for the changes have been added (for bug fixes / features)
- [x] (If applicable) Documentation has been added / updated (for bug
fixes / features)
- [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?

* Flips the option `as_dataset` to True, i.e. all indicators now return
Datasets by default.

### Does this PR introduce a breaking change?
Oh my it does!

### Other information:
@Ouranosinc/xclim-core This seems one of the biggest breaking change in
v1, just look at the size of this single commit!

I think this is better, but I could be convinced that breaking worflows
this much is not worth it.

To go back to the previous situation, one simply needs to do
`xclim.set_options(as_dataset=False)`, in a context or even globally.

Coverage Stats

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

2 existing lines in 1 file now uncovered.

7993 of 8822 relevant lines covered (90.6%)

7.64 hits per line