Docstanya

Lib/MV2.py

@@ -79,7 +79,6 @@ def __init__(self, mafunc):
         """
         Parameters
         ----------
-
             var_unary_operation(mafunc)
 
             mafunc is an numpy.ma masked_unary_function.
@@ -124,7 +123,6 @@ def commonDomain(a, b, omit=None):
 
         commonDomain(a,b)
             tests that the domains of variables/arrays a and b are equal,
-            and
 
     Returns
     -------
@@ -146,14 +144,15 @@ def commonDomain(a, b, omit=None):
 
 
 def commonAxes(a, bdom, omit=None):
-    """Helper function for commonDomain.
+    """
+    Helper function for commonDomain.
 
     Parameters
     ----------
-
-        'a' is a variable or array,
-
-        'b' is an axislist or None.
+    'a':
+        is a variable or array,
+    'b':
+        is an axislist or None.
     """
     if isinstance(a, AbstractVariable) and bdom is not None:
         adom = a.getAxisList()
@@ -272,7 +271,6 @@ def __init__(self, mafunc):
         ----------
 
             var_binary_operation(mafunc)
-
             mafunc is an numpy.ma masked_binary_function.
         """
         self.mafunc = mafunc
@@ -935,13 +933,14 @@ def outer(self, a, b):
 
 
 def asarray(data, typecode=None, dtype=None):
-    """asarray(data, typecode=None, dtype=None) is equivalent to array(data, dtype=None, copy=0)
+    """
+    asarray(data, typecode=None, dtype=None) is equivalent to array(data, dtype=None, copy=0)
 
 
-     Returns
-     -------
+    Returns
+    -------
 
-          data if dtype is None or data is a MaskedArray of the same dtype.
+        data if dtype is None or data is a MaskedArray of the same dtype.
           typecode arg is for backward compatibility.
     """
     dtype = _convdtype(dtype, typecode)
@@ -1061,7 +1060,8 @@ def resize(a, new_shape, axes=None, attributes=None, id=None, grid=None):
     -------
          a new array with the specified shape.
 
-    The original array's total size can be any size."""
+    The original array's total size can be any size.
+    """
     ignore, attributes, id, ignore = _extractMetadata(a, axes, attributes, id)
     if axes is not None:
         axesshape = [len(item) for item in axes]
@@ -1099,7 +1099,6 @@ def masked_values(data, value, rtol=1.e-5, atol=1.e-8, copy=1,
     """
     Parameters
     ----------
-
         masked_values(data, value, rtol=1.e-5, atol=1.e-8)
 
         Create a masked array; mask is None if possible.
@@ -1131,7 +1130,6 @@ def isMaskedVariable(x):
 
 def set_default_fill_value(value_type, value):
     """Set the default fill value for value_type to value.
-
     Parameters
     ----------
         value_type is a string:
@@ -1164,7 +1162,6 @@ def diagonal(a, offset=0, axis1=0, axis2=1):
 
     Returns
     -------
-
         the given diagonals defined by the two dimensions of the array.
     """
     F = getattr(a, "fill_value", 1.e20)

Lib/avariable.py

@@ -701,17 +701,15 @@ def getOrder(self, ids=0):
         """
         Parameters
         ----------
-
-            id:
-                0 or 1
+        id:
+          0 or 1
 
         Returns
         -------
-
         the order string, such as t, z, y, x (time, level, lat, lon).
 
         Note
-
+        ----
         * if ids == 0 (the default) for an axis that is not t,z,x,y
           the order string will contain a (-) character in that location.
           The result string will be of the same length as the number

Lib/axis.py

@@ -1255,8 +1255,7 @@ def mapInterval(self, interval, indicator='ccn', cycle=None):
 
         Returns
         -------
-
-            The corresponding index interval (i,j), where i<j, indicating
+        The corresponding index interval (i,j), where i<j, indicating
         the half-open index interval [i,j), or None if the intersection is empty.
 
         For an axis which is circular (self.topology == 'circular'), [i,j)

Lib/cache.py

@@ -326,8 +326,8 @@ def put(self, filekey, path):
 
         Parameters
         ----------
-            <filekey>
-            filekey for cache
+        filekey:
+             for cache
         """
 
         filekey = str(filekey)

Lib/database.py

@@ -55,7 +55,6 @@ def connect(uri=None, user="", password=""):
        Database instance
 
     Example
-
         db = cdms.connect("ldap://dbhost.llnl.gov/database=CDMS,ou=PCMDI,o=LLNL,c=US")
     """
     if uri is None:
@@ -312,7 +311,6 @@ def openDataset(self, dsetid, mode='r'):
           Dataset instance.
 
         Example
-
           dset = db.openDataset('ncep_reanalysis_mo')
         """
         dn = "dataset=%s,%s" % (dsetid, self.path)
@@ -416,7 +414,6 @@ def searchFilter(self, filter=None, tag=None, relbase=None,
               Entries can be refined with searchPredicate().
 
         Example
-
         (1) Find all variables named "cli":
 
           result = db.searchFilter(filter="id=cli",tag="variable")
@@ -529,7 +526,6 @@ def searchPredicate(self, predicate, tag=None):
            Entries can be refined with searchPredicate().
 
         Example
-
             (1) Find all variables on a 73x96 grid
 
             newresult = result.searchPredicate(lambda obj: obj.getGrid().shape==(73,96),"variable")
@@ -561,11 +557,9 @@ def __init__(self, db):
     def getObject(self):
         """
         Method
-
           getObject()
 
         Description
-
           Get the CDMS object associated with this entry.
 
         Returns

Lib/dataset.py

@@ -2138,8 +2138,8 @@ def write(self, var, attributes=None, axes=None, extbounds=None, id=None,
 
         Parameters
         ----------
-          var:
-              variable to copy.
+            var:
+                variable to copy.
           attributes:
               The attribute dictionary for the variable. The default is var.attributes.
           axes:
@@ -2160,6 +2160,7 @@ def write(self, var, attributes=None, axes=None, extbounds=None, id=None,
               The numpy dtype.
           typecode:
               Deprecated, for backward compatibility only
+
         Returns
         -------
             File variable
@@ -2316,9 +2317,11 @@ def write_it_yourself(self, obj):
            ----------
               obj:
                  object containing `writeg`, `writeToFile` or `write` method.
+
            Returns
            -------
-              Nothig is returned. """
+              Nothing is returned.
+       """
         # This method was formerly called writeg and just wrote an
         # AbstractCurveGrid.
         if (hasattr(obj, 'writeg') and callable(getattr(obj, 'writeg'))):

Lib/forecast.py

@@ -85,15 +85,13 @@ class forecast():
            is used to get the forecast file from the forecast time.
 
     Example
-    -------
 
-          Each list item should look like this example:
+       Each list item should look like this example:
        [None, None, None, None, 2006022200000L, 'file2006-02-22-00000.nc']
        Normally dataset_list = fm[i][1] where fm is the output of
        cdms2.dataset.parseFileMap and fm[i][0] matches the variables of interest.
 
     Note
-    ----
 
        N.B.  This is like a CdmsFile.  Creating a forecast means opening a file,
        so later on you should call forecast.close() to close it.
@@ -139,7 +137,6 @@ def available_forecasts(dataset_file, path="."):
           through the specified cdscan-generated dataset xml file.
 
     Note
-
          The forecasts are given in 64-bit integer format, but can be converted
          to component times with the function two_times_from_one.
          This function may help in choosing the right arguments for initializing
@@ -157,8 +154,6 @@ class forecasts():
     Represents a set of forecasts
 
     Example
-
-
              Creates a set of forecasts.  Normally you do it by something like
              f = forecasts( 'file.xml', (min_time, max_time) )
              or
@@ -256,7 +251,7 @@ def time_interval_to_list(self, tlo, thi, openclosed='co'):
     def reduce_inplace(self, min_time, max_time, openclosed='co'):
         """
         Example
-
+        =======
 
              For a forecasts object f, f( min_time, max_time ) will reduce the
              scope of f, to forecasts whose start time t has min_time<=t<max_time.
@@ -366,7 +361,6 @@ def forecast_axis(self, varname, fcss=None):
              a tuple (axis,start,length,true_length) where axis is in the forecast direction.
 
         Note
-
              If a list of forecasts be specified, the axis' data will be limited to them."""
         if fcss is None:
             fcss = self.fcs

Lib/grid.py

@@ -752,10 +752,10 @@ def writeScrip(self, cufile, gridTitle=None):
 
         Parameters
         ----------
-             cufile:
+             cufile
                  is a Cdunif file, NOT a CDMS file.
 
-             gridtitle:
+             gridtitle
                  is a string identifying the grid.
 
         """
@@ -768,11 +768,9 @@ def toCurveGrid(self, gridid=None):
 
         Parameters
         ----------
-              gridid:
+              gridid
                  is the string identifier of the resulting curvilinear grid object.
 
-              _: None
-
         """
 
         from .coord import TransientVirtualAxis, TransientAxis2D

Lib/hgrid.py

@@ -189,23 +189,20 @@ def fixCutCells(self, nonConvexCells, threshold=270.0):
 
         Parameters
         ----------
-
         nonConvexCells:
                   1D numpy array of indices of nonconvex cells, as returned from
                   checkConvex.
         threshold:
                   positive floating-point value in degrees.
 
 
-        If the difference in longitude values of consecutive boundaries nodes exceeds the
-        threshold, the cell is considered a cut cell.
-
-        On return, the grid boundaries are modified.
+        If the difference in longitude values of consecutive boundaries nodes
+        exceeds the threshold, the cell is considered a cut cell. On return,
+        the grid boundaries are modified.
 
         Returns
         -------
-
-            value is a 1D array of indices of cells that cannot be repaired.
+        value is a 1D array of indices of cells that cannot be repaired.
         """
 
         from numpy import take, array
@@ -583,7 +580,7 @@ def writeg(self, file):
         file.close()
 
     def write_gridspec(self, filename):
-        """writes this grid to a Gridspec-compliant file, or does nothing if there is
+        """Writes this grid to a Gridspec-compliant file, or does nothing if there is
         already a known file corresponding to this grid.  The filename should be a
         complete path."""
         # This method was never completed because the libCF functionality I had planned to
@@ -600,7 +597,7 @@ def write_gridspec(self, filename):
                 'The libCF/Gridspec API does not provide for writing CurveGrids<<<')
 
     def init_from_gridspec(self, filename):
-        """reads to grid from a Gridspec-compliant file.  The filename should be a
+        """Reads to grid from a Gridspec-compliant file.  The filename should be a
         complete path.  The contents of the file may overwrite data in the existing
         grid object."""
         # - This is really a kind of init function.  The __init__ function should
@@ -618,7 +615,7 @@ def init_from_gridspec(self, filename):
         f.close()
 
     def init_from_gridspec_file(self, f):
-        """reads to grid from a Gridspec-compliant file, f.  This f should be a
+        """Reads to grid from a Gridspec-compliant file, f.  This f should be a
         CdmsFile object, already open for reading.  The contents of the file may
         overwrite data in the existing grid object."""
         # As for the above init_from_gridspec method, this is really a kind of

Lib/tvariable.py

@@ -583,8 +583,8 @@ def clone(self, copyData=1):
         -------
 
             a copy of self as a transient variable.
-
-            If copyData is 1 (default), make a separate copy of the data."""
+            If copyData is 1 (default), make a separate copy of the data.
+        """
         result = createVariable(self, copy=copyData)
         return result