Fix *args, **kwargs

"inline emphasis..."
pydata · Feb 27, 2019 · 1b9da35 · 1b9da35
1 parent 39983a5
commit 1b9da35
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 22 deletions.
diff --git a/xarray/core/alignment.py b/xarray/core/alignment.py
@@ -35,7 +35,7 @@ def _get_joiner(join):
 
 
 def align(*objects, **kwargs):
-    """align(*objects, join='inner', copy=True, indexes=None,
+    """align(\*objects, join='inner', copy=True, indexes=None,
              exclude=frozenset())
 
     Given any number of Dataset and/or DataArray objects, returns new
@@ -48,7 +48,7 @@ def align(*objects, **kwargs):
 
     Parameters
     ----------
-    *objects : Dataset or DataArray
+    \*objects : Dataset or DataArray
         Objects to align.
     join : {'outer', 'inner', 'left', 'right', 'exact'}, optional
         Method for joining the indexes of the passed objects along each
@@ -73,7 +73,7 @@ def align(*objects, **kwargs):
 
     Returns
     -------
-    aligned : same as *objects
+    aligned : same as \*objects
         Tuple of objects with aligned coordinates.
 
     Raises
@@ -413,7 +413,7 @@ def broadcast(*args, **kwargs):
 
     Parameters
     ----------
-    *args : DataArray or Dataset objects
+    \*args : DataArray or Dataset objects
         Arrays to broadcast against each other.
     exclude : sequence of str, optional
         Dimensions that must not be broadcasted

diff --git a/xarray/core/common.py b/xarray/core/common.py
@@ -352,7 +352,7 @@ def assign_coords(self, **kwargs):
     def assign_attrs(self, *args, **kwargs):
         """Assign new attrs to this object.
 
-        Returns a new object equivalent to self.attrs.update(*args, **kwargs).
+        Returns a new object equivalent to self.attrs.update(\*args, \*\*kwargs).
 
         Parameters
         ----------
@@ -374,7 +374,7 @@ def assign_attrs(self, *args, **kwargs):
 
     def pipe(self, func, *args, **kwargs):
         """
-        Apply func(self, *args, **kwargs)
+        Apply func(self, \*args, \*\*kwargs)
 
         This method replicates the pandas method of the same name.
 

diff --git a/xarray/core/dataarray.py b/xarray/core/dataarray.py
@@ -632,7 +632,7 @@ def load(self, **kwargs):
 
         Parameters
         ----------
-        **kwargs : dict
+        \*\*kwargs : dict
             Additional keyword arguments passed on to ``dask.array.compute``.
 
         See Also
@@ -657,7 +657,7 @@ def compute(self, **kwargs):
 
         Parameters
         ----------
-        **kwargs : dict
+        \*\*kwargs : dict
             Additional keyword arguments passed on to ``dask.array.compute``.
 
         See Also
@@ -676,7 +676,7 @@ def persist(self, **kwargs):
 
         Parameters
         ----------
-        **kwargs : dict
+        \*\*kwargs : dict
             Additional keyword arguments passed on to ``dask.persist``.
 
         See Also
@@ -997,7 +997,7 @@ def interp(self, coords=None, method='linear', assume_sorted=False,
             values.
         kwargs: dictionary
             Additional keyword passed to scipy's interpolator.
-        **coords_kwarg : {dim: coordinate, ...}, optional
+        \*\*coords_kwarg : {dim: coordinate, ...}, optional
             The keyword arguments form of ``coords``.
             One of coords or coords_kwargs must be provided.
 
@@ -1579,7 +1579,7 @@ def reduce(self, func, dim=None, axis=None, keep_attrs=None, **kwargs):
         ----------
         func : function
             Function which can be called in the form
-            `f(x, axis=axis, **kwargs)` to return the result of reducing an
+            `f(x, axis=axis, \*\*kwargs)` to return the result of reducing an
             np.ndarray over an integer valued axis.
         dim : str or sequence of str, optional
             Dimension(s) over which to apply `func`.
@@ -1592,7 +1592,7 @@ def reduce(self, func, dim=None, axis=None, keep_attrs=None, **kwargs):
             If True, the variable's attributes (`attrs`) will be copied from
             the original object to the new one.  If False (default), the new
             object will be returned without attributes.
-        **kwargs : dict
+        \*\*kwargs : dict
             Additional keyword arguments passed on to `func`.
 
         Returns
@@ -2320,7 +2320,7 @@ def quantile(self, q, dim=None, interpolation='linear', keep_attrs=None):
             is a scalar. If multiple percentiles are given, first axis of
             the result corresponds to the quantile and a quantile dimension
             is added to the return array. The other dimensions are the
-             dimensions that remain after the reduction of the array.
+            dimensions that remain after the reduction of the array.
 
         See Also
         --------
@@ -2427,7 +2427,7 @@ def differentiate(self, coord, edge_order=1, datetime_unit=None):
         return self._from_temp_dataset(ds)
 
     def integrate(self, dim, datetime_unit=None):
-        """ integrate the array with the trapezoidal rule.
+        """ Integrate the array with the trapezoidal rule.
 
         .. note::
             This feature is limited to simple cartesian geometry, i.e. coord

diff --git a/xarray/core/dataset.py b/xarray/core/dataset.py
@@ -494,7 +494,7 @@ def load(self: T, **kwargs) -> T:
 
         Parameters
         ----------
-        **kwargs : dict
+        \*\*kwargs : dict
             Additional keyword arguments passed on to ``dask.array.compute``.
 
         See Also
@@ -626,7 +626,7 @@ def compute(self: T, **kwargs) -> T:
 
         Parameters
         ----------
-        **kwargs : dict
+        \*\*kwargs : dict
             Additional keyword arguments passed on to ``dask.array.compute``.
 
         See Also
@@ -663,7 +663,7 @@ def persist(self: T, **kwargs) -> T:
 
         Parameters
         ----------
-        **kwargs : dict
+        \*\*kwargs : dict
             Additional keyword arguments passed on to ``dask.persist``.
 
         See Also
@@ -3046,7 +3046,7 @@ def reduce(self, func, dim=None, keep_attrs=None, numeric_only=False,
         ----------
         func : function
             Function which can be called in the form
-            `f(x, axis=axis, **kwargs)` to return the result of reducing an
+            `f(x, axis=axis, \*\*kwargs)` to return the result of reducing an
             np.ndarray over an integer valued axis.
         dim : str or sequence of str, optional
             Dimension(s) over which to apply `func`.  By default `func` is
@@ -3057,7 +3057,7 @@ def reduce(self, func, dim=None, keep_attrs=None, numeric_only=False,
             object will be returned without attributes.
         numeric_only : bool, optional
             If True, only apply ``func`` to variables with a numeric dtype.
-        **kwargs : dict
+        \*\*kwargs : dict
             Additional keyword arguments passed on to ``func``.
 
         Returns
@@ -3117,7 +3117,7 @@ def apply(self, func, keep_attrs=None, args=(), **kwargs):
         Parameters
         ----------
         func : function
-            Function which can be called in the form `func(x, *args, **kwargs)`
+            Function which can be called in the form `func(x, \*args, \*\*kwargs)`
             to transform each DataArray `x` in this dataset into another
             DataArray.
         keep_attrs : bool, optional
@@ -3126,7 +3126,7 @@ def apply(self, func, keep_attrs=None, args=(), **kwargs):
             be returned without attributes.
         args : tuple, optional
             Positional arguments passed on to `func`.
-        **kwargs : dict
+        \*\*kwargs : dict
             Keyword arguments passed on to `func`.
 
         Returns
@@ -4109,7 +4109,7 @@ def filter_by_attrs(self, **kwargs):
 
         Parameters
         ----------
-        **kwargs : key=value
+        \*\*kwargs : key=value
             key : str
                 Attribute name.
             value : callable or obj