Skip to content

Commit

Permalink
Ammended cube.var_name documentation. (#2874)
Browse files Browse the repository at this point in the history
Ammended cube.var_name documentation to refer to it as NetCDF.
  • Loading branch information
Luke Carroll authored and pelson committed Oct 27, 2017
1 parent 5bfb85e commit 2ed03db
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions lib/iris/cube.py
Original file line number Diff line number Diff line change
Expand Up @@ -672,7 +672,7 @@ def __init__(self, data, standard_name=None, long_name=None,
* long_name
An unconstrained description of the cube.
* var_name
The CF variable name for the cube.
The netCDF variable name for the cube.
* units
The unit of the cube, e.g. ``"m s-1"`` or ``"kelvin"``.
* attributes
Expand Down Expand Up @@ -724,7 +724,7 @@ def __init__(self, data, standard_name=None, long_name=None,
#: The "long name" for the Cube's phenomenon.
self.long_name = long_name

#: The CF variable name for the Cube.
#: The netCDF variable name for the Cube.
self.var_name = var_name

self.cell_methods = cell_methods
Expand Down Expand Up @@ -1180,7 +1180,7 @@ def aux_factory(self, name=None, standard_name=None, long_name=None,
An unconstrained description of the coordinate factory.
If None, does not check for long_name.
* var_name
The CF variable name of the desired coordinate factory.
The netCDF variable name of the desired coordinate factory.
If None, does not check for var_name.
.. note::
Expand Down Expand Up @@ -1250,8 +1250,8 @@ def coords(self, name_or_coord=None, standard_name=None,
An unconstrained description of the coordinate. If None, does not
check for long_name.
* var_name
The CF variable name of the desired coordinate. If None, does not
check for var_name.
The netCDF variable name of the desired coordinate. If None, does
not check for var_name.
* attributes
A dictionary of attributes desired on the coordinates. If None,
does not check for attributes.
Expand Down

0 comments on commit 2ed03db

Please sign in to comment.