Merge branch 'main' into api_toc_expand

docs/src/further_topics/filtering_warnings.rst

@@ -49,7 +49,7 @@ Warnings:
     ...
     iris/coord_systems.py:442: IrisUserWarning: Setting inverse_flattening does not affect other properties of the GeogCS object. To change other properties set them explicitly or create a new GeogCS instance.
       warnings.warn(wmsg, category=iris.exceptions.IrisUserWarning)
-    iris/coord_systems.py:782: IrisDefaultingWarning: Discarding false_easting and false_northing that are not used by Cartopy.
+    iris/coord_systems.py:768: IrisDefaultingWarning: Discarding false_easting and false_northing that are not used by Cartopy.
       warnings.warn(
 
 Warnings can be suppressed using the Python warnings filter with the ``ignore``
@@ -130,7 +130,7 @@ Or you can target Warnings raised by specific lines of specific modules, e.g.
     ...
     iris/coord_systems.py:442: IrisUserWarning: Setting inverse_flattening does not affect other properties of the GeogCS object. To change other properties set them explicitly or create a new GeogCS instance.
       warnings.warn(wmsg, category=iris.exceptions.IrisUserWarning)
-    iris/coord_systems.py:782: IrisDefaultingWarning: Discarding false_easting and false_northing that are not used by Cartopy.
+    iris/coord_systems.py:768: IrisDefaultingWarning: Discarding false_easting and false_northing that are not used by Cartopy.
       warnings.warn(
 
 ::

lib/iris/_lazy_data.py

@@ -252,7 +252,7 @@ def as_lazy_data(
     Notes
     -----
     The result chunk size is a multiple of 'chunks', if given, up to the
-    dask default chunksize, i.e. `dask.config.get('array.chunk-size'),
+    dask default chunksize, i.e. `dask.config.get('array.chunk-size')`,
     or the full data shape if that is smaller.
     If 'chunks' is not given, the result has chunks of the full data shape,
     but reduced by a factor if that exceeds the dask default chunksize.

lib/iris/_merge.py

@@ -5,7 +5,7 @@
 """Automatic collation of cubes into higher-dimensional cubes.
 
 Typically the cube merge process is handled by
-:method:`iris.cube.CubeList.merge`.
+:meth:`iris.cube.CubeList.merge`.
 
 """
 

lib/iris/coord_categorisation.py

@@ -40,7 +40,7 @@ def add_categorised_coord(cube, name, from_coord, category_function, units="1"):
     category_function : callable
         function(coordinate, value), returning a category value for a
         coordinate point-value
-    units : str, optional, default="1"
+    units : str, default="1"
         units of the category value, typically 'no_unit' or '1'.
     """
     # Interpret coord, if given as a name
@@ -303,7 +303,7 @@ def add_season(cube, coord, name="season", seasons=("djf", "mam", "jja", "son"))
         it.
     coord : :class:`iris.coords.Coord` or str
         Coordinate in 'cube', or its name, representing time.
-    name : str, optional
+    name : str, default="season"
         Name of the created coordinate. Defaults to "season".
     seasons : :class:`list` of str, optional
         List of seasons defined by month abbreviations. Each month must
@@ -341,7 +341,7 @@ def add_season_number(
         it.
     coord : :class:`iris.coords.Coord` or str
         Coordinate in 'cube', or its name, representing time.
-    name : str, optional
+    name : str, default="season"
         Name of the created coordinate. Defaults to "season_number".
     seasons : :class:`list` of str, optional
         List of seasons defined by month abbreviations. Each month must
@@ -425,7 +425,7 @@ def add_season_membership(cube, coord, season, name="season_membership"):
         Coordinate in 'cube', or its name, representing time.
     season : str
         Season defined by month abbreviations.
-    name : str, optional
+    name : str, default="season_membership"
         Name of the created coordinate. Defaults to "season_membership".
 
     """