velin docstring fixes (#168)

Author: dcherian

cf_xarray/accessor.py

@@ -222,9 +222,9 @@ def _get_groupby_time_accessor(var: Union[DataArray, Dataset], key: str) -> List
 
     Parameters
     ----------
-    var: DataArray, Dataset
+    var : DataArray, Dataset
         DataArray belonging to the coordinate to be checked
-    key: str, [e.g. "T.month"]
+    key : str, [e.g. "T.month"]
         key to check for.
 
     Returns
@@ -255,14 +255,14 @@ def _get_axis_coord(var: Union[DataArray, Dataset], key: str) -> List[str]:
 
     Parameters
     ----------
-    var: DataArray, Dataset
+    var : DataArray, Dataset
         DataArray belonging to the coordinate to be checked
-    key: str, ["X", "Y", "Z", "T", "longitude", "latitude", "vertical", "time"]
+    key : str, ["X", "Y", "Z", "T", "longitude", "latitude", "vertical", "time"]
         key to check for.
-    error: bool
+    error : bool
         raise errors when key is not found or interpretable. Use False and provide default
         to replicate dict.get(k, None).
-    default: Any
+    default : Any
         default value to return when error is False.
 
     Returns
@@ -330,9 +330,9 @@ def _get_measure(obj: Union[DataArray, Dataset], key: str) -> List[str]:
 
     Parameters
     ----------
-    obj: DataArray, Dataset
+    obj : DataArray, Dataset
         DataArray belonging to the coordinate to be checked
-    key: str
+    key : str
         key to check for.
 
     Returns
@@ -471,18 +471,17 @@ def _getattr(
 
     Parameters
     ----------
-
     obj : DataArray, Dataset
     attr : Name of attribute in obj that will be shadowed.
     accessor : High level accessor object: CFAccessor
     key_mappers : dict
         dict(key_name: mapper)
-    wrap_classes: bool
+    wrap_classes : bool
         Should we wrap the return value with _CFWrappedClass?
         Only True for the high level CFAccessor.
         Facilitates code reuse for _CFWrappedClass and _CFWrapppedPlotMethods
         For both of those, wrap_classes is False.
-    extra_decorator: Callable (optional)
+    extra_decorator : Callable (optional)
         An extra decorator, if necessary. This is used by _CFPlotMethods to set default
         kwargs based on CF attributes.
     """
@@ -555,9 +554,9 @@ def _getitem(
 
     Parameters
     ----------
-    accessor: CFAccessor
-    key: str, List[str]
-    skip: str, optional
+    accessor : CFAccessor
+    key : str, List[str]
+    skip : str, optional
         One of ["coords", "measures"], avoid clashes with special coord names
     """
 
@@ -889,12 +888,12 @@ def _rewrite_values(
 
         Parameters
         ----------
-        kwargs: Mapping
+        kwargs : Mapping
             Mapping from kwarg name to value
-        key_mappers: Mapping
+        key_mappers : Mapping
             Mapping from kwarg name to a Mapper function that will convert a
             given CF "special" name to an xarray name.
-        var_kws: List[str]
+        var_kws : List[str]
             List of variable kwargs that need special treatment.
             e.g. **indexers_kwargs in isel
 
@@ -1188,8 +1187,7 @@ def standard_names(self) -> Dict[str, List[str]]:
 
         Parameters
         ----------
-
-        obj: DataArray, Dataset
+        obj : DataArray, Dataset
             Xarray object to process
 
         Returns
@@ -1222,14 +1220,10 @@ def get_associated_variable_names(
 
         Parameters
         ----------
-
-        name: Hashable
-
-        skip_bounds: bool, optional
-
+        name : Hashable
+        skip_bounds : bool, optional
         Returns
         ------
-
         Dict with keys "ancillary_variables", "cell_measures", "coordinates", "bounds"
         """
         keys = ["ancillary_variables", "cell_measures", "coordinates", "bounds"]
@@ -1306,7 +1300,7 @@ def rename_like(
 
         Parameters
         ----------
-        other: DataArray, Dataset
+        other : DataArray, Dataset
             Variables will be renamed to match variable names in this xarray object
 
         Returns
@@ -1351,7 +1345,7 @@ def guess_coord_axis(self, verbose: bool = False) -> Union[DataArray, Dataset]:
 
         Parameters
         ----------
-        verbose: bool
+        verbose : bool
             Print extra info to screen
 
         Returns
@@ -1420,7 +1414,7 @@ def get_bounds(self, key: str) -> DataArray:
 
         Parameters
         ----------
-        key: str
+        key : str
             Name of variable whose bounds are desired
 
         Returns
@@ -1462,7 +1456,7 @@ def add_bounds(self, dims: Union[Hashable, Iterable[Hashable]]):
 
         Parameters
         ----------
-        dims: Hashable or Iterable[Hashable]
+        dims : Hashable or Iterable[Hashable]
             Either a single dimension name or a list of dimension names.
 
         Returns
@@ -1584,7 +1578,7 @@ def decode_vertical_coords(self, prefix="z"):
 
         Parameters
         ----------
-        prefix: str, optional
+        prefix : str, optional
             Prefix for newly created z variables.
             E.g. ``s_rho`` becomes ``z_rho``
 
@@ -1594,7 +1588,6 @@ def decode_vertical_coords(self, prefix="z"):
 
         Notes
         -----
-
         Will only decode when the ``formula_terms`` and ``standard_name`` attributes
         are set on the parameter (e.g ``s_rho`` )
 

cf_xarray/helpers.py

@@ -17,7 +17,7 @@ def bounds_to_vertices(
 
     Parameters
     ----------
-    bounds: DataArray
+    bounds : DataArray
         The bounds to convert. Must be of shape (N, 2) or (N, M, 4).
     bounds_dim : str
         The name of the bounds dimension of `bounds` (the one of length 2 or 4).
@@ -93,7 +93,7 @@ def vertices_to_bounds(
 
     Parameters
     ----------
-    bounds: DataArray
+    bounds : DataArray
         The bounds to convert. Must be of shape (N, 2) or (N, M, 4).
     out_dims : Sequence[str],
         The name of the dimension in the output. The first is the 'bounds'

cf_xarray/utils.py

@@ -29,7 +29,7 @@ def parse_cell_methods_attr(attr: str) -> Dict[str, str]:
 
     Parameters
     ----------
-    attr: str
+    attr : str
         String to parse
 
     Returns