Ouranosinc / xclim / 18499870221

92%

push

github

Fix history handling (#2251)

<!--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 #2240 
- [x] Tests for the changes have been added (for bug fixes / features)
- [ ] (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?

* When `as_dataset=True` is activated, "history" is not added on the
dataarray. Adding an history to a variable is not CF-compliant. We are
doing it because we wouldn't have this information otherwise. But when
in dataset mode, there's no need to do it (it is already added to the
dataset).
* The `update_history` function was adding the new history at the end of
the string. It should be at the top. The CF convention says "append",
the netCDF user guide says "append", but I'm pretty sure that's loose
language as all nc utilities I've encountered (`ncks` and the like)
update the history by _prepending_.

### Does this PR introduce a breaking change?
As in most cases, this is a gray area.

### Other information:

3 of 3 new or added lines in 2 files covered. (100.0%)

7843 of 8514 relevant lines covered (92.12%)

8.07 hits per line