Fix docstring re structured text warnings (SciTools#3073) (SciTools#3197

)
znicholls · Jun 15, 2019 · 880d4d8 · 880d4d8
1 parent 6f4424c
commit 880d4d8
Show file tree

Hide file tree

Showing 6 changed files with 10 additions and 4 deletions.
diff --git a/lib/iris/analysis/calculus.py b/lib/iris/analysis/calculus.py
@@ -243,7 +243,7 @@ def differentiate(cube, coord_to_differentiate):
     and `C` and `B` the output coordinate values and bounds.
 
     .. note:: Difference method used is the same as :func:`cube_delta`
-    and therefore has the same limitations.
+        and therefore has the same limitations.
 
     .. note:: Spherical differentiation does not occur in this routine.
 

diff --git a/lib/iris/analysis/trajectory.py b/lib/iris/analysis/trajectory.py
@@ -70,7 +70,7 @@ def __init__(self, waypoints, sample_count=10):
             Trajectory(waypoints)
 
         .. note:: All the waypoint dictionaries must contain the same
-        coordinate names.
+            coordinate names.
 
         Args:
 

diff --git a/lib/iris/cube.py b/lib/iris/cube.py
@@ -3651,6 +3651,7 @@ def interpolate(self, sample_points, scheme, collapse_scalar=True):
             The type of interpolation to use to interpolate from this
             :class:`~iris.cube.Cube` to the given sample points. The
             interpolation schemes currently available in Iris are:
+
                 * :class:`iris.analysis.Linear`, and
                 * :class:`iris.analysis.Nearest`.
 
@@ -3723,6 +3724,7 @@ def regrid(self, grid, scheme):
             The type of regridding to use to regrid this cube onto the
             target grid. The regridding schemes currently available
             in Iris are:
+
                 * :class:`iris.analysis.Linear`,
                 * :class:`iris.analysis.Nearest`, and
                 * :class:`iris.analysis.AreaWeighted`.

diff --git a/lib/iris/experimental/stratify.py b/lib/iris/experimental/stratify.py
@@ -115,7 +115,7 @@ def relevel(cube, src_levels, tgt_levels, axis=None, interpolator=None):
         If the interpolator is None, :func:`stratify.interpolate` will be used
         with linear interpolation and NaN extrapolation.
 
-        An example of constructing an alternative interpolation scheme:
+        An example of constructing an alternative interpolation scheme::
 
             from functools import partial
             interpolator = partial(stratify.interpolate,

diff --git a/lib/iris/fileformats/name_loaders.py b/lib/iris/fileformats/name_loaders.py
@@ -864,11 +864,15 @@ def load_NAMEIII_version2(filename):
     """
     Load a NAME III version 2 file returning a
     generator of :class:`iris.cube.Cube` instances.
+
     Args:
+
     * filename (string):
         Name of file to load.
+
     Returns:
         A generator :class:`iris.cube.Cube` instances.
+
     """
 
     # loading a file gives a generator of lines which can be progressed

diff --git a/lib/iris/fileformats/pp.py b/lib/iris/fileformats/pp.py
@@ -1887,7 +1887,7 @@ def load_pairs_from_fields(pp_fields):
         An iterable of :class:`iris.fileformats.pp.PPField`.
 
     Returns:
-        An iterable of :class:`iris.cube.Cube`s.
+        An iterable of :class:`iris.cube.Cube`\ s.
 
     This capability can be used to filter out fields before they are passed to
     the load pipeline, and amend the cubes once they are created, using