Skip to content

Commit e5b3c6b

Browse files
committed
Added whatsnew, and minimal links in other docs sections.
1 parent fb7074f commit e5b3c6b

File tree

3 files changed

+27
-3
lines changed

3 files changed

+27
-3
lines changed

docs/src/userguide/loading_iris_cubes.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,12 @@ Iris will attempt to return **as few cubes as possible**
1515
by collecting together multiple fields with a shared standard name
1616
into a single multidimensional cube.
1717

18+
.. hint::
19+
20+
There are some hints at :class:`iris.CombineOptions` on how Iris works to load
21+
fewer and larger cubes, along with user options that can aid in controlling the
22+
process.
23+
1824
The :py:func:`iris.load` function automatically recognises the format
1925
of the given files and attempts to produce Iris Cubes from their contents.
2026

docs/src/whatsnew/latest.rst

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,13 +30,30 @@ This document explains the changes made to Iris for this release
3030
✨ Features
3131
===========
3232

33-
#. N/A
33+
#. `@pp-mo`_ renamed the :class:`iris.LoadPolicy` as :class:`iris.CombineOptions` and
34+
:data:`iris.LOAD_POLICY` as :data:`iris.COMBINE_POLICY`, though the original names
35+
remain functional (and refer to the same things) for now.
36+
(:issue:`6203`, :pull:`6334`)
37+
38+
#. `@pp-mo`_ added new :meth:`~iris.cube.CubeList.combine` and
39+
:meth:`~iris.cube.CubeList.combine_cube` methods of a :class:`~iris.cube.CubeList`
40+
as an alternative way of accessing the :func:`~iris.util.combine_cubes` mechanism.
41+
(:issue:`6203`, :pull:`6334`)
42+
43+
#. `@pp-mo`_ added a new utility function :func:`~iris.util.combine_cubes`, to give
44+
general public access to the combine merge/concatenate mechanism introduced for
45+
generalised loading support via :class:`iris.LoadPolicy` in the Iris 3.11 release.
46+
(:issue:`6203`, :pull:`6334`)
47+
48+
#. `@pp-mo`_ overhauled the :class:`iris.LoadPolicy` facility by adding a new
49+
``equalise_cubes_kwarg`` keyword, enabling it to call the
50+
:func:`~iris.util.equalise_cubes` utility function as one of its processing stages.
51+
(:issue:`6203`, :pull:`6334`)
3452

3553
#. `@pp-mo`_ added a new utility function :func:`~iris.util.equalise_cubes`, to help
3654
with aligning cubes so they can merge / concatenate.
3755
(:issue:`6248`, :pull:`6257`)
3856

39-
4057
#. `@fnattino`_ added the lazy median aggregator :class:`iris.analysis.MEDIAN`
4158
based on the implementation discussed by `@rcomer`_ and `@stefsmeets`_ in
4259
:issue:`4039` (:pull:`6167`).

lib/iris/__init__.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,8 @@
1616
The :func:`load` function provides a simple way to explore data from
1717
the interactive Python prompt. It will convert the source data into
1818
:class:`Cubes <iris.cube.Cube>`, and combine those cubes into
19-
higher-dimensional cubes where possible.
19+
higher-dimensional cubes where possible
20+
(for which, please see :class:`iris.CombineOptions`).
2021
2122
The :func:`load_cube` and :func:`load_cubes` functions are similar to
2223
:func:`load`, but they raise an exception if the number of cubes is not

0 commit comments

Comments
 (0)