Replace time_dim_mode with time_dims#967
Merged
Merged
Conversation
Tests, examples and documentation adapted accordingly
Doc on dimensions updated. Tests for the new `time_dims` kwarg and dim collisions added.
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## develop #967 +/- ##
===========================================
+ Coverage 81.08% 81.26% +0.17%
===========================================
Files 222 223 +1
Lines 14489 14624 +135
Branches 718 718
===========================================
+ Hits 11749 11884 +135
Misses 2521 2521
Partials 219 219 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Collaborator
|
@pawel-wolff, thank your for this important development and for writing all the docs and tests. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
The Xarray engine kwarg
time_dim_modehas been replaced withtime_dims- an explicit list of time-related dimension role names.Tests, examples and documentation have been adapted accordingly.
As an extra, a mechanism of ignoring a colliding dimension has been improved: if a dimension declared in the kwarg
extra_dimscollides with pre-defined dimensions, then it is silently ignored. A related paragraph in the documentation has been added, as well as relevant tests.Contributor Declaration
By opening this pull request, I affirm the following: