Skip to content

Commit 08c5280

Browse files
committed
Minor corrections to merge and concatenate userguide.
1 parent f621b70 commit 08c5280

File tree

1 file changed

+10
-9
lines changed

1 file changed

+10
-9
lines changed

docs/iris/src/userguide/merge_and_concat.rst

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -253,7 +253,7 @@ of cubes and returns a new :class:`~iris.cube.CubeList` containing the cubes
253253
that have been concatenated.
254254

255255
Let's have a look at the :meth:`~iris.cube.CubeList.concatenate` method in operation.
256-
In the example below we have three 3D (*x*, *y*, *t*) cubes whose ``t`` coordinates
256+
In the example below we have three 3D ``(t, y, x)`` cubes whose ``t`` coordinates
257257
have sequentially increasing ranges.
258258
These cubes can be concatenated by combining the ``t`` coordinates of the input
259259
cubes to form a new cube with an extended ``t`` coordinate:
@@ -306,7 +306,7 @@ of cubes returned.
306306

307307
To demonstrate the differences between :meth:`~iris.cube.CubeList.concatenate`
308308
and :meth:`~iris.cube.CubeList.concatenate_cube`, let's return to our three cubes
309-
from the earlier merge example.
309+
from the earlier concatenate example.
310310

311311
For the purposes of this example we'll add a *History* attribute to the first
312312
cube's :data:`~iris.cube.Cube.attributes` dictionary.
@@ -355,7 +355,7 @@ All the cubes that can be concatenated have been. Any cubes that can't be concat
355355
included unchanged in the returned :class:`~iris.cube.CubeList`.
356356
When :meth:`~iris.cube.CubeList.concatenate_cube` is called on ``cubes`` it raises a
357357
descriptive error that highlights the difference in the ``attributes`` dictionaries.
358-
It is this difference that is preventing ``cube`` being concatenate into a
358+
It is this difference that is preventing ``cube`` being concatenated into a
359359
single cube. An example of fixing an issue like this can be found in the
360360
:ref:`merge_concat_common_issues` section.
361361

@@ -392,9 +392,8 @@ Merge
392392

393393
**Attributes Mismatch**
394394

395-
Differences in the :data:`~iris.cube.Cube.attributes` (a cube's metadata, including
396-
coordinate metadata) of the input cubes probably cause the greatest amount of
397-
merge-related difficulties.
395+
Differences in the :data:`~iris.cube.Cube.attributes` the input cubes probably
396+
cause the greatest amount of merge-related difficulties.
398397
In recognition of this, Iris has a helper function,
399398
:func:`~iris.experimental.equalise_cubes.equalise_attributes`, to equalise
400399
attributes differences in the input cubes.
@@ -484,7 +483,8 @@ scalar ``z`` coordinate with value 2 and the third has a scalar ``z``
484483
coordinate with value 1.
485484
The first and third cubes are thus identical.
486485
We will demonstrate the effect of merging the input cubes with ``unique=False``
487-
(duplicate cubes allowed) and ``unique=True`` (duplicate cubes not allowed):
486+
(duplicate cubes allowed) and ``unique=True`` (duplicate cubes not allowed, which
487+
is the default behaviour):
488488

489489
.. testsetup:: merge_duplicate
490490

@@ -531,13 +531,14 @@ error highlighting the presence of the duplicate cube.
531531
Coordinates containing only a single value can cause confusion when
532532
combining input cubes. In Iris' terminology a **scalar** coordinate is a
533533
coordinate of length 1 *which does not describe a data dimension*. Remember:
534+
534535
* The ``merge`` process combines multiple input cubes into a
535536
single resultant cube with new dimensions created from the
536-
*scalar coordinate values* of the input cubes.
537+
**scalar** *coordinate values* of the input cubes.
537538
* The ``concatenate`` process process combines multiple input cubes into a
538539
single resultant cube with the same *number of dimensions* as the input cubes,
539540
but with the length of one or more dimensions extended by *joining together
540-
sequential dimension coordinates*.
541+
sequential* **dimension** *coordinates*.
541542

542543

543544
Let's look at two example cubes to demonstrate this.

0 commit comments

Comments
 (0)