Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 11, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion lib/iris/analysis/calculus.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion lib/iris/analysis/trajectory.py
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
2 changes: 2 additions & 0 deletions lib/iris/cube.py
Original file line number Diff line number Diff line change
Expand Up @@ -3645,6 +3645,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`.

Expand Down Expand Up @@ -3717,6 +3718,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`.
Expand Down
2 changes: 1 addition & 1 deletion lib/iris/experimental/stratify.py
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
4 changes: 4 additions & 0 deletions lib/iris/fileformats/name_loaders.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion lib/iris/fileformats/pp.py
Original file line number Diff line number Diff line change
Expand Up @@ -1886,7 +1886,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
Expand Down