ruff compliance for D409 and D410. (#5662)

* ruff compliance for D409 and D410.

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* fix doctest.

* fix line

* fix doctest.

* fix merge

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

.ruff.toml

@@ -43,8 +43,6 @@ lint.ignore = [
     "D405",  # Section name should be properly capitalized
     "D406",  # Section name should end with a newline
     "D407",  # Missing dashed underline after section
-    "D409",  # Section underline should match the length of its name
-    "D410",  # Missing blank line after section
 
     # pyupgrade (UP)
     # https://docs.astral.sh/ruff/rules/#pyupgrade-up

lib/iris/analysis/cartography.py

@@ -65,7 +65,7 @@ def wrap_lons(lons, base, period):
         [-175.   30.  160.   75.]
 
     Notes
-    ------
+    -----
     This function maintains laziness when called; it does not realise data.
     See more at :doc:`/userguide/real_and_lazy_data`.
     """
@@ -258,7 +258,7 @@ def get_xy_grids(cube):
         x, y = get_xy_grids(cube)
 
     Notes
-    ------
+    -----
     This function maintains laziness when called; it does not realise data.
     See more at :doc:`/userguide/real_and_lazy_data`.
     """
@@ -289,7 +289,7 @@ def get_xy_contiguous_bounded_grids(cube):
         xs, ys = get_xy_contiguous_bounded_grids(cube)
 
     Notes
-    ------
+    -----
     This function maintains laziness when called; it does not realise data.
     See more at :doc:`/userguide/real_and_lazy_data`.
 
@@ -499,7 +499,7 @@ def cosine_latitude_weights(cube):
         weights = np.sqrt(cosine_latitude_weights(cube))
 
     Notes
-    ------
+    -----
     This function maintains laziness when called; it does not realise data.
     See more at :doc:`/userguide/real_and_lazy_data`.
     """

lib/iris/analysis/maths.py

@@ -107,7 +107,7 @@ def abs(cube, in_place=False):
         An instance of :class:`iris.cube.Cube`.
 
     Notes
-    ------
+    -----
     This function maintains laziness when called; it does not realise data.
     See more at :doc:`/userguide/real_and_lazy_data`.
 
@@ -154,7 +154,7 @@ def intersection_of_cubes(cube, other_cube):
           cube1, cube2 = (intersections[0], intersections[1])
 
     Notes
-    ------
+    -----
     This function maintains laziness when called; it does not realise data.
     See more at :doc:`/userguide/real_and_lazy_data`.
 
@@ -236,7 +236,7 @@ def add(cube, other, dim=None, in_place=False):
     iris.cube.Cube
 
     Notes
-    ------
+    -----
     This function maintains laziness when called; it does not realise data.
     See more at :doc:`/userguide/real_and_lazy_data`.
 
@@ -289,7 +289,7 @@ def subtract(cube, other, dim=None, in_place=False):
     iris.cube.Cube
 
     Notes
-    ------
+    -----
     This function maintains laziness when called; it does not realise data.
     See more at :doc:`/userguide/real_and_lazy_data`.
 
@@ -392,7 +392,7 @@ def multiply(cube, other, dim=None, in_place=False):
     iris.cube.Cube
 
     Notes
-    ------
+    -----
     This function maintains laziness when called; it does not realise data.
     See more at :doc:`/userguide/real_and_lazy_data`.
     """
@@ -476,7 +476,7 @@ def divide(cube, other, dim=None, in_place=False):
     iris.cube.Cube
 
     Notes
-    ------
+    -----
     This function maintains laziness when called; it does not realise data.
     See more at :doc:`/userguide/real_and_lazy_data`.
     """
@@ -542,7 +542,7 @@ def exponentiate(cube, exponent, in_place=False):
         An instance of :class:`iris.cube.Cube`.
 
     Notes
-    ------
+    -----
     This function maintains laziness when called; it does not realise data.
     See more at :doc:`/userguide/real_and_lazy_data`.
     """
@@ -593,7 +593,7 @@ def exp(cube, in_place=False):
         An instance of :class:`iris.cube.Cube`.
 
     Notes
-    ------
+    -----
     This function maintains laziness when called; it does not realise data.
     See more at :doc:`/userguide/real_and_lazy_data`.
 
@@ -623,7 +623,7 @@ def log(cube, in_place=False):
         An instance of :class:`iris.cube.Cube`.
 
     Notes
-    ------
+    -----
     This function maintains laziness when called; it does not realise data.
     See more at :doc:`/userguide/real_and_lazy_data`.
 
@@ -657,7 +657,7 @@ def log2(cube, in_place=False):
         An instance of :class:`iris.cube.Cube`.
 
     Notes
-    ------
+    -----
     This function maintains laziness when called; it does not realise data.
     See more at :doc:`/userguide/real_and_lazy_data`.
 
@@ -687,7 +687,7 @@ def log10(cube, in_place=False):
         An instance of :class:`iris.cube.Cube`.
 
     Notes
-    ------
+    -----
     This function maintains laziness when called; it does not realise data.
     See more at :doc:`/userguide/real_and_lazy_data`.
 

lib/iris/analysis/trajectory.py

@@ -207,7 +207,7 @@ def interpolate(cube, sample_points, method=None):
         interpolated_cube = interpolate(cube, sample_points)
 
     Notes
-    ------
+    -----
     This function does not maintain laziness when called; it realises data.
     See more at :doc:`/userguide/real_and_lazy_data`.
     """

lib/iris/common/resolve.py

@@ -205,7 +205,7 @@ class Resolve:
         >>> resolver = Resolve(cube1, cube2)
         >>> results = [resolver.cube(data) for data in payload]
 
-    """  # noqa: D214, D411
+    """  # noqa: D214, D410, D411
 
     def __init__(self, lhs=None, rhs=None):
         """Resolve the provided ``lhs`` :class:`~iris.cube.Cube` operand and
@@ -2493,7 +2493,7 @@ def mapped(self):
             >>> resolver.map_rhs_to_lhs
             False
 
-        """  # noqa: D214, D411
+        """  # noqa: D214, D410, D411
         result = None
         if self.mapping is not None:
             result = self._src_cube.ndim == len(self.mapping)
@@ -2554,5 +2554,5 @@ def shape(self):
             >>> Resolve(cube2, cube1).shape
             (240, 37, 49)
 
-        """  # noqa: D214, D411
+        """  # noqa: D214, D410, D411
         return self._broadcast_shape

lib/iris/cube.py

@@ -4517,7 +4517,8 @@ def rolling_window(self, coord, aggregator, window, **kwargs):
             Notice that the forecast_period dimension now represents the 4
             possible windows of size 3 from the original cube.
 
-        """  # noqa: D214, D411
+        """  # noqa: D214, D410, D411
+
         # Update weights kwargs (if necessary) to handle different types of
         # weights
         weights_info = None

lib/iris/fileformats/dot.py

@@ -345,8 +345,7 @@ def _dot_node(indent, id, name, attributes):
         The visual name of the node.
     attributes:
         An iterable of (name, value) attribute pairs.
-
-    """  # noqa: D411
+    """  # noqa: D410, D411
     attributes = r"\n".join("%s: %s" % item for item in attributes)
     template = """%(indent)s"%(id)s" [
 %(indent)s    label = "%(name)s|%(attributes)s"

lib/iris/iterate.py

@@ -58,7 +58,7 @@ def izip(*cubes, **kwargs):
         ...    pass
 
     Notes
-    ------
+    -----
     This function maintains laziness when called; it does not realise data.
     See more at :doc:`/userguide/real_and_lazy_data`.
     """

lib/iris/palette.py

@@ -117,7 +117,7 @@ def cmap_norm(cube):
         :class:`iris.palette.SymmetricNormalize`
 
     Notes
-    ------
+    -----
     This function maintains laziness when called; it does not realise data.
     See more at :doc:`/userguide/real_and_lazy_data`.
 

lib/iris/pandas.py

@@ -217,7 +217,7 @@ def as_cubes(
         :class:`~iris.coords.AncillaryVariable` objects.
 
     Returns
-    --------
+    -------
     :class:`~iris.cube.CubeList`
         One :class:`~iris.cube.Cube` for each column not referenced in
         `aux_coord_cols`/`cell_measure_cols`/`ancillary_variable_cols`.
@@ -584,7 +584,7 @@ def as_series(cube, copy=True):
     make sure it is not masked and use copy=False.
 
     Notes
-    ------
+    -----
     Since this function converts to/from a Pandas object, laziness will not be preserved.
 
     """
@@ -797,7 +797,7 @@ def as_data_frame(
     Name: surface_temperature, Length: 419904, dtype: float32
 
     Notes
-    ------
+    -----
     Since this function converts to/from a Pandas object, laziness will not be preserved.
 
     """