Skip to content

Commit

Permalink
wip
Browse files Browse the repository at this point in the history
  • Loading branch information
tkknight committed Dec 6, 2023
1 parent 7bba3ec commit 515d380
Show file tree
Hide file tree
Showing 3 changed files with 425 additions and 435 deletions.
26 changes: 13 additions & 13 deletions lib/iris/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -304,12 +304,12 @@ def load(uris, constraints=None, callback=None):
Parameters
----------
uris: str or :class:`pathlib.PurePath`
uris : str or :class:`pathlib.PurePath`
One or more filenames/URIs, as a string or :class:`pathlib.PurePath`.
If supplying a URL, only OPeNDAP Data Sources are supported.
constraints: optional
constraints : optional
One or more constraints.
callback: optional
callback : optional
A modifier/filter function.
Returns
Expand All @@ -332,12 +332,12 @@ def load_cube(uris, constraint=None, callback=None):
Parameters
----------
uris:
uris :
One or more filenames/URIs, as a string or :class:`pathlib.PurePath`.
If supplying a URL, only OPeNDAP Data Sources are supported.
constraints: optional
constraints : optional
A constraint.
callback: optional
callback : optional
A modifier/filter function.
Returns
Expand Down Expand Up @@ -370,12 +370,12 @@ def load_cubes(uris, constraints=None, callback=None):
Parameters
----------
uris:
uris :
One or more filenames/URIs, as a string or :class:`pathlib.PurePath`.
If supplying a URL, only OPeNDAP Data Sources are supported.
constraints: optional
constraints : optional
One or more constraints.
callback: optional
callback : optional
A modifier/filter function.
Returns
Expand Down Expand Up @@ -415,12 +415,12 @@ def load_raw(uris, constraints=None, callback=None):
Parameters
----------
uris:
uris :
One or more filenames/URIs, as a string or :class:`pathlib.PurePath`.
If supplying a URL, only OPeNDAP Data Sources are supported.
constraints: optional
constraints : optional
One or more constraints.
callback: optional
callback : optional
A modifier/filter function.
Returns
Expand Down Expand Up @@ -479,7 +479,7 @@ def use_plugin(plugin_name):
Parameters
----------
plugin_name: str
plugin_name : str
Name of plugin.
Examples
Expand Down
22 changes: 11 additions & 11 deletions lib/iris/_constraints.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,16 +33,16 @@ def __init__(self, name=None, cube_func=None, coord_values=None, **kwargs):
Parameters
----------
name: str or None, optional
name : str or None, optional
If a string, it is used as the name to match against the
:attr:`iris.cube.Cube.names` property. TREMTEST
cube_func: callable or None, optional
cube_func : callable or None, optional
If a callable, it must accept a Cube as its first and only argument
and return either True or False.
coord_values: dict or None, optional
coord_values : dict or None, optional
If a dict, it must map coordinate name to the condition on the
associated coordinate.
**kwargs:
**kwargs :
The remaining keyword arguments are converted to coordinate
constraints. The name of the argument gives the name of a
coordinate, and the value of the argument is the condition to meet
Expand Down Expand Up @@ -293,9 +293,9 @@ def __init__(self, coord_name, coord_thing):
Parameters
----------
coord_name: str
coord_name : str
The name of the coordinate to constrain
coord_thing:
coord_thing :
The object to compare
"""
Expand Down Expand Up @@ -584,7 +584,7 @@ def __repr__(self):


class NameConstraint(Constraint):
"""Provides a simple Cube name based :class:`Constraint`."""
"""Provide a simple Cube name based :class:`Constraint`."""

def __init__(
self,
Expand All @@ -606,15 +606,15 @@ def __init__(
Parameters
----------
standard_name: optional
standard_name : optional
A string or callable representing the standard name to match
against.
long_name: optional
long_name : optional
A string or callable representing the long name to match against.
var_name: optional
var_name : optional
A string or callable representing the NetCDF variable name to match
against.
STASH: optional
STASH : optional
A string or callable representing the UM STASH code to match
against.
Expand Down
Loading

0 comments on commit 515d380

Please sign in to comment.