Amend var_name documentation (#3020)

Amend documentation to be explicit that var_name is a netCDF quantity, not necessarily a CF one.
SciTools · May 23, 2018 · e275b70 · e275b70
1 parent 82a6076
commit e275b70
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 15 deletions.
diff --git a/lib/iris/_cube_coord_common.py b/lib/iris/_cube_coord_common.py
@@ -138,18 +138,18 @@ def units(self, unit):
 
     @property
     def var_name(self):
-        """The CF variable name for the object."""
+        """The netCDF variable name for the object."""
         return self._var_name
 
     @var_name.setter
     def var_name(self, name):
         if name is not None:
             if not name:
-                raise ValueError('An empty string is not a valid CF variable '
-                                 'name.')
+                raise ValueError('An empty string is not a valid netCDF '
+                                 'variable name.')
             elif set(name).intersection(string.whitespace):
-                raise ValueError('{!r} is not a valid CF variable name because'
-                                 ' it contains whitespace.'.format(name))
+                raise ValueError('{!r} is not a valid netCDF variable name '
+                                 'as it contains whitespace.'.format(name))
         self._var_name = name
 
     @property

diff --git a/lib/iris/aux_factory.py b/lib/iris/aux_factory.py
@@ -1,4 +1,4 @@
-# (C) British Crown Copyright 2010 - 2017, Met Office
+# (C) British Crown Copyright 2010 - 2018, Met Office
 #
 # This file is part of Iris.
 #
@@ -51,7 +51,7 @@ def __init__(self):
         #: Descriptive name of the coordinate made by the factory
         self.long_name = None
 
-        #: CF variable name of the coordinate made by the factory
+        #: netCDF variable name for the coordinate made by the factory
         self.var_name = None
 
         #: Coordinate system (if any) of the coordinate made by the factory

diff --git a/lib/iris/coords.py b/lib/iris/coords.py
@@ -418,11 +418,11 @@ def __init__(self, points, standard_name=None, long_name=None,
         Kwargs:
 
         * standard_name:
-            CF standard name of coordinate
+            CF standard name of the coordinate.
         * long_name:
-            Descriptive name of coordinate
+            Descriptive name of the coordinate.
         * var_name:
-            CF variable name of coordinate
+            The netCDF variable name for the coordinate.
         * units
             The :class:`~cf_units.Unit` of the coordinate's values.
             Can be a string, which will be converted to a Unit object.
@@ -446,7 +446,7 @@ def __init__(self, points, standard_name=None, long_name=None,
         #: Descriptive name of the coordinate.
         self.long_name = long_name
 
-        #: The CF variable name for the coordinate.
+        #: The netCDF variable name for the coordinate.
         self.var_name = var_name
 
         #: Unit of the quantity that the coordinate represents.
@@ -1883,11 +1883,11 @@ def __init__(self, data, standard_name=None, long_name=None,
         Kwargs:
 
         * standard_name:
-            CF standard name of coordinate
+            CF standard name of the coordinate.
         * long_name:
-            Descriptive name of coordinate
+            Descriptive name of the coordinate.
         * var_name:
-            CF variable name of coordinate
+            The netCDF variable name for the coordinate.
         * units
             The :class:`~cf_units.Unit` of the coordinate's values.
             Can be a string, which will be converted to a Unit object.
@@ -1904,7 +1904,7 @@ def __init__(self, data, standard_name=None, long_name=None,
         #: Descriptive name of the coordinate.
         self.long_name = long_name
 
-        #: The CF variable name for the coordinate.
+        #: The netCDF variable name for the coordinate.
         self.var_name = var_name
 
         #: Unit of the quantity that the coordinate represents.