Skip to content

Commit 1b9da35

Browse files
author
dcherian
committed
Fix *args, **kwargs
"inline emphasis..."
1 parent 39983a5 commit 1b9da35

File tree

4 files changed

+22
-22
lines changed

4 files changed

+22
-22
lines changed

‎xarray/core/alignment.py‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ def _get_joiner(join):
3535

3636

3737
def align(*objects, **kwargs):
38-
"""align(*objects, join='inner', copy=True, indexes=None,
38+
"""align(\*objects, join='inner', copy=True, indexes=None,
3939
exclude=frozenset())
4040
4141
Given any number of Dataset and/or DataArray objects, returns new
@@ -48,7 +48,7 @@ def align(*objects, **kwargs):
4848
4949
Parameters
5050
----------
51-
*objects : Dataset or DataArray
51+
\*objects : Dataset or DataArray
5252
Objects to align.
5353
join : {'outer', 'inner', 'left', 'right', 'exact'}, optional
5454
Method for joining the indexes of the passed objects along each
@@ -73,7 +73,7 @@ def align(*objects, **kwargs):
7373
7474
Returns
7575
-------
76-
aligned : same as *objects
76+
aligned : same as \*objects
7777
Tuple of objects with aligned coordinates.
7878
7979
Raises
@@ -413,7 +413,7 @@ def broadcast(*args, **kwargs):
413413
414414
Parameters
415415
----------
416-
*args : DataArray or Dataset objects
416+
\*args : DataArray or Dataset objects
417417
Arrays to broadcast against each other.
418418
exclude : sequence of str, optional
419419
Dimensions that must not be broadcasted

‎xarray/core/common.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -352,7 +352,7 @@ def assign_coords(self, **kwargs):
352352
def assign_attrs(self, *args, **kwargs):
353353
"""Assign new attrs to this object.
354354
355-
Returns a new object equivalent to self.attrs.update(*args, **kwargs).
355+
Returns a new object equivalent to self.attrs.update(\*args, \*\*kwargs).
356356
357357
Parameters
358358
----------
@@ -374,7 +374,7 @@ def assign_attrs(self, *args, **kwargs):
374374

375375
def pipe(self, func, *args, **kwargs):
376376
"""
377-
Apply func(self, *args, **kwargs)
377+
Apply func(self, \*args, \*\*kwargs)
378378
379379
This method replicates the pandas method of the same name.
380380

‎xarray/core/dataarray.py‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -632,7 +632,7 @@ def load(self, **kwargs):
632632
633633
Parameters
634634
----------
635-
**kwargs : dict
635+
\*\*kwargs : dict
636636
Additional keyword arguments passed on to ``dask.array.compute``.
637637
638638
See Also
@@ -657,7 +657,7 @@ def compute(self, **kwargs):
657657
658658
Parameters
659659
----------
660-
**kwargs : dict
660+
\*\*kwargs : dict
661661
Additional keyword arguments passed on to ``dask.array.compute``.
662662
663663
See Also
@@ -676,7 +676,7 @@ def persist(self, **kwargs):
676676
677677
Parameters
678678
----------
679-
**kwargs : dict
679+
\*\*kwargs : dict
680680
Additional keyword arguments passed on to ``dask.persist``.
681681
682682
See Also
@@ -997,7 +997,7 @@ def interp(self, coords=None, method='linear', assume_sorted=False,
997997
values.
998998
kwargs: dictionary
999999
Additional keyword passed to scipy's interpolator.
1000-
**coords_kwarg : {dim: coordinate, ...}, optional
1000+
\*\*coords_kwarg : {dim: coordinate, ...}, optional
10011001
The keyword arguments form of ``coords``.
10021002
One of coords or coords_kwargs must be provided.
10031003
@@ -1579,7 +1579,7 @@ def reduce(self, func, dim=None, axis=None, keep_attrs=None, **kwargs):
15791579
----------
15801580
func : function
15811581
Function which can be called in the form
1582-
`f(x, axis=axis, **kwargs)` to return the result of reducing an
1582+
`f(x, axis=axis, \*\*kwargs)` to return the result of reducing an
15831583
np.ndarray over an integer valued axis.
15841584
dim : str or sequence of str, optional
15851585
Dimension(s) over which to apply `func`.
@@ -1592,7 +1592,7 @@ def reduce(self, func, dim=None, axis=None, keep_attrs=None, **kwargs):
15921592
If True, the variable's attributes (`attrs`) will be copied from
15931593
the original object to the new one. If False (default), the new
15941594
object will be returned without attributes.
1595-
**kwargs : dict
1595+
\*\*kwargs : dict
15961596
Additional keyword arguments passed on to `func`.
15971597
15981598
Returns
@@ -2320,7 +2320,7 @@ def quantile(self, q, dim=None, interpolation='linear', keep_attrs=None):
23202320
is a scalar. If multiple percentiles are given, first axis of
23212321
the result corresponds to the quantile and a quantile dimension
23222322
is added to the return array. The other dimensions are the
2323-
dimensions that remain after the reduction of the array.
2323+
dimensions that remain after the reduction of the array.
23242324
23252325
See Also
23262326
--------
@@ -2427,7 +2427,7 @@ def differentiate(self, coord, edge_order=1, datetime_unit=None):
24272427
return self._from_temp_dataset(ds)
24282428

24292429
def integrate(self, dim, datetime_unit=None):
2430-
""" integrate the array with the trapezoidal rule.
2430+
""" Integrate the array with the trapezoidal rule.
24312431
24322432
.. note::
24332433
This feature is limited to simple cartesian geometry, i.e. coord

‎xarray/core/dataset.py‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -494,7 +494,7 @@ def load(self: T, **kwargs) -> T:
494494
495495
Parameters
496496
----------
497-
**kwargs : dict
497+
\*\*kwargs : dict
498498
Additional keyword arguments passed on to ``dask.array.compute``.
499499
500500
See Also
@@ -626,7 +626,7 @@ def compute(self: T, **kwargs) -> T:
626626
627627
Parameters
628628
----------
629-
**kwargs : dict
629+
\*\*kwargs : dict
630630
Additional keyword arguments passed on to ``dask.array.compute``.
631631
632632
See Also
@@ -663,7 +663,7 @@ def persist(self: T, **kwargs) -> T:
663663
664664
Parameters
665665
----------
666-
**kwargs : dict
666+
\*\*kwargs : dict
667667
Additional keyword arguments passed on to ``dask.persist``.
668668
669669
See Also
@@ -3046,7 +3046,7 @@ def reduce(self, func, dim=None, keep_attrs=None, numeric_only=False,
30463046
----------
30473047
func : function
30483048
Function which can be called in the form
3049-
`f(x, axis=axis, **kwargs)` to return the result of reducing an
3049+
`f(x, axis=axis, \*\*kwargs)` to return the result of reducing an
30503050
np.ndarray over an integer valued axis.
30513051
dim : str or sequence of str, optional
30523052
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,
30573057
object will be returned without attributes.
30583058
numeric_only : bool, optional
30593059
If True, only apply ``func`` to variables with a numeric dtype.
3060-
**kwargs : dict
3060+
\*\*kwargs : dict
30613061
Additional keyword arguments passed on to ``func``.
30623062
30633063
Returns
@@ -3117,7 +3117,7 @@ def apply(self, func, keep_attrs=None, args=(), **kwargs):
31173117
Parameters
31183118
----------
31193119
func : function
3120-
Function which can be called in the form `func(x, *args, **kwargs)`
3120+
Function which can be called in the form `func(x, \*args, \*\*kwargs)`
31213121
to transform each DataArray `x` in this dataset into another
31223122
DataArray.
31233123
keep_attrs : bool, optional
@@ -3126,7 +3126,7 @@ def apply(self, func, keep_attrs=None, args=(), **kwargs):
31263126
be returned without attributes.
31273127
args : tuple, optional
31283128
Positional arguments passed on to `func`.
3129-
**kwargs : dict
3129+
\*\*kwargs : dict
31303130
Keyword arguments passed on to `func`.
31313131
31323132
Returns
@@ -4109,7 +4109,7 @@ def filter_by_attrs(self, **kwargs):
41094109
41104110
Parameters
41114111
----------
4112-
**kwargs : key=value
4112+
\*\*kwargs : key=value
41134113
key : str
41144114
Attribute name.
41154115
value : callable or obj

0 commit comments

Comments
 (0)