Remove mapslices and mention dropdims in docs #558
Conversation
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
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #558 +/- ##
=======================================
Coverage 69.80% 69.80%
=======================================
Files 14 14
Lines 2113 2113
=======================================
Hits 1475 1475
Misses 638 638 🚀 New features to boost your workflow:
|
briochemc
reviewed
Oct 22, 2025
| ```` | ||
| There is no time dimension left, because there is only one value left after averaging all time steps. | ||
|
|
||
| The time dimension has only a single value indicating the time interval that was used for the average. To remove this singleton dimension you can use `dropdims`. |
There was a problem hiding this comment.
I don't think this is necessary anymore since now the behavior is the same as in Base. Maybe just a tip admonition, like below? (Not sure this is the right format for DocumenterVitepress 😅)
> [!TIP]
> To remove the time dimension, use the `dropdims = true` keyword.
|
Yes, I think it's good! But maybe you don't even need this much? (see comment). |
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.
This changes the wording in the docs for mapslices to explain, that the time dimension is still going to be around and how to get rid of it via dropdims.
This closes #545
@briochemc Do you think that explanation to be clear?