DOC: Note about collapsing multi-dimensional coordinates #1819
Conversation
This file contains 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
|
|
||
| Instead you must either fully collapse the coordinate (in this case | ||
| requiring that both ``grid_latitude`` or ``grid_longitude`` coordinates be | ||
| collapsed together in a single collapse operation) or not collapse the |
There was a problem hiding this comment.
Third option - remove the surface altitude.
|
👍 in principle. My major hesitation is on the addition to the userguide. Could you take a look at the built userguide, and tell me if you think the addition makes the flow work as well in the context of it being a document designed to be used as a readable narrative? The addition to the reference documentation I am absolutely 👍 on. |
| @@ -98,6 +98,22 @@ in the gallery takes a zonal mean of an ``XYT`` cube by using the | |||
| ``collapsed`` method with ``latitude`` and ``iris.analysis.MEAN`` as arguments. | |||
|
|
|||
|
|
|||
| .. note:: | |||
| You cannot partially collapse a multi-dimensional coordinate. Thus in the | |||
There was a problem hiding this comment.
Action: make into a single sentence and cross reference "reference docs".
|
As per @pelson's suggestions above, I have:
|
pelson
added a commit
that referenced
this pull request
Nov 23, 2015
DOC: Note about collapsing multi-dimensional coordinates
agbutteriss
added a commit
to agbutteriss/iris
that referenced
this pull request
Aug 4, 2016
agbutteriss
added a commit
to agbutteriss/iris
that referenced
this pull request
Aug 10, 2016
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.
Adds a note on partially collapsing multi-dimensional coordinates to the userguide §9.1,
iris.cube.Cube.collapsedandiris.coords.Coord.collapsed.