rebase latest changes

docs/src/whatsnew/dev.rst

@@ -16,12 +16,14 @@ This document explains the changes made to Iris for this release
 
    The highlights for this minor release of Iris include:
 
-   * We've added experimental support for `UGRID`_ meshes which can now be loaded
-     and attached to a cube.
+   * We've added experimental support for
+     :ref:`Meshes <ugrid>`, which can now be loaded and
+     attached to a cube. Mesh support is based on the based on `CF-UGRID`_
+     model.
    * We've also dropped support for ``Python 3.7``.
 
-   And finally, get in touch with us on `GitHub`_ if you have any issues or
-   feature requests for improving Iris. Enjoy!
+   And finally, get in touch with us on :issue:`GitHub<new/choose>` if you have
+   any issues or feature requests for improving Iris. Enjoy!
 
 
 📢 Announcements
@@ -37,7 +39,7 @@ This document explains the changes made to Iris for this release
 ===========
 
 #. `@bjlittle`_, `@pp-mo`_, `@trexfeathers`_ and `@stephenworsley`_ added
-   support for unstructured meshes, as described by `UGRID`_. This involved
+   support for :ref:`unstructured meshes <ugrid>`. This involved
    adding a data model (:pull:`3968`, :pull:`4014`, :pull:`4027`, :pull:`4036`,
    :pull:`4053`, :pull:`4439`) and API (:pull:`4063`, :pull:`4064`), and
    supporting representation (:pull:`4033`, :pull:`4054`) of data on meshes.
@@ -54,14 +56,14 @@ This document explains the changes made to Iris for this release
    :class:`~iris.cube.Cube` via a :class:`~iris.experimental.ugrid.mesh.MeshCoord`.
 
 #. `@trexfeathers`_ added support for loading unstructured mesh data from netcdf data,
-   for files using the `UGRID`_ conventions.
+   for files using the `CF-UGRID`_ conventions.
    The context manager :obj:`~iris.experimental.ugrid.load.PARSE_UGRID_ON_LOAD`
    provides a way to load UGRID files so that :class:`~iris.cube.Cube`\ s can be
    returned with a :class:`~iris.experimental.ugrid.mesh.Mesh` attached.
    (:pull:`4058`).
 
-#. `@pp-mo`_ added support to save cubes with meshes to netcdf files, using the
-   `UGRID`_ conventions.
+#. `@pp-mo`_ added support to save cubes with :ref:`meshes <ugrid>` to netcdf
+   files, using the `CF-UGRID`_ conventions.
    The existing :meth:`iris.save` function now does this, when saving cubes with meshes.
    A routine :meth:`iris.experimental.ugrid.save.save_mesh` allows saving
    :class:`~iris.experimental.ugrid.mesh.Mesh` objects to netcdf *without* any associated data
@@ -82,7 +84,7 @@ This document explains the changes made to Iris for this release
    :class:`~iris.coords.AuxCoord` :attr:`~iris.coords.AuxCoord.points` and
    :class:`~iris.experimental.ugrid.mesh.Connectivity`
    :attr:`~iris.experimental.ugrid.mesh.Connectivity.indices` under the
-   `UGRID`_ model. (:pull:`4375`)
+   :ref:`mesh model <ugrid model>`. (:pull:`4375`)
 
 #. `@bsherratt`_ added a `threshold` parameter to
    :meth:`~iris.cube.Cube.intersection` (:pull:`4363`)
@@ -191,6 +193,10 @@ This document explains the changes made to Iris for this release
    :class:`benchmarks.HorizontalChunkedRegridding` shows a time decrease
    from >10s to 625ms. (:issue:`4280`, :pull:`4400`)
 
+#. `@bjlittle`_ included an optimisation to :class:`~iris.cube.Cube.coord_dims`
+   to avoid unnecessary processing whenever a coordinate instance that already
+   exists within the cube is provided. (:pull:`4549`)
+
 
 🔥 Deprecations
 ===============
@@ -220,6 +226,14 @@ This document explains the changes made to Iris for this release
    ``as_compatible_shape(src_cube, target_cube)`` replace with
    ``Resolve(src_cube, target_cube)(target_cube.core_data())``. (:pull:`4513`)
 
+#. `@wjbenfold`_ deprecated :func:`iris.analysis.maths.intersection_of_cubes` in
+   preference for :meth:`iris.cube.CubeList.extract_overlapping`. The
+   :func:`~iris.analysis.maths.intersection_of_cubes` function will be removed in
+   a future release of Iris. (:pull:`4541`)
+
+#. `@pp-mo`_ deprecated :mod:`iris.experimental.regrid_conservative`.  This is
+   now replaced by `iris-emsf-regrid`_
+
 
 🔗 Dependencies
 ===============
@@ -313,15 +327,15 @@ This document explains the changes made to Iris for this release
    :func:`~iris.analysis.cartography.wrap_lons` and updated affected tests
    using assertArrayAllClose following :issue:`3993`.
    (:pull:`4421`)
-   
+
 #. `@rcomer`_ updated some tests to work with Matplotlib v3.5. (:pull:`4428`)
 
 #. `@rcomer`_ applied minor fixes to some regridding tests. (:pull:`4432`)
 
 #. `@lbdreyer`_ corrected the license PyPI classifier. (:pull:`4435`)
 
-#. `@aaronspring <https://github.com/aaronspring>`_ exchanged `dask` with
-   `dask-core` in testing environments reducing the number of dependencies
+#. `@aaronspring <https://github.com/aaronspring>`_ exchanged ``dask`` with
+   ``dask-core`` in testing environments reducing the number of dependencies
    installed for testing. (:pull:`4434`)
 
 #. `@wjbenfold`_ prevented github action runs in forks (:issue:`4441`,
@@ -345,9 +359,9 @@ This document explains the changes made to Iris for this release
 .. comment
     Whatsnew resources in alphabetical order:
 
-.. _GitHub: https://github.com/SciTools/iris/issues/new/choose
 .. _NEP-29: https://numpy.org/neps/nep-0029-deprecation_policy.html
+.. _Metarelate: http://www.metarelate.net/
 .. _UGRID: http://ugrid-conventions.github.io/ugrid-conventions/
-.. _sort-all: https://github.com/aio-libs/sort-all
+.. _iris-emsf-regrid: https://github.com/SciTools-incubator/iris-esmf-regrid
 .. _faster documentation building: https://docs.readthedocs.io/en/stable/guides/conda.html#making-builds-faster-with-mamba
-.. _Metarelate: http://www.metarelate.net/
+.. _sort-all: https://github.com/aio-libs/sort-all