Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Minor docstring fixes #3615

Merged
merged 1 commit into from
Dec 12, 2019
Merged

Minor docstring fixes #3615

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions xarray/core/dataarray.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1115,7 +1115,7 @@ def thin(
**indexers_kwargs: Any,
) -> "DataArray":
"""Return a new DataArray whose data is given by each `n` value
along the specified dimension(s). Default `n` = 5
along the specified dimension(s).

See Also
--------
Expand Down Expand Up @@ -1289,7 +1289,7 @@ def reindex(
satisfy the equation ``abs(index[indexer] - target) <= tolerance``.
fill_value : scalar, optional
Value to use for newly missing values
**indexers_kwarg : {dim: indexer, ...}, optional
**indexers_kwargs : {dim: indexer, ...}, optional
The keyword arguments form of ``indexers``.
One of indexers or indexers_kwargs must be provided.

Expand Down Expand Up @@ -1338,7 +1338,7 @@ def interp(
values.
kwargs: dictionary
Additional keyword passed to scipy's interpolator.
``**coords_kwarg`` : {dim: coordinate, ...}, optional
``**coords_kwargs`` : {dim: coordinate, ...}, optional
The keyword arguments form of ``coords``.
One of coords or coords_kwargs must be provided.

Expand Down Expand Up @@ -2740,7 +2740,7 @@ def shift(
Value to use for newly missing values
**shifts_kwargs:
The keyword arguments form of ``shifts``.
One of shifts or shifts_kwarg must be provided.
One of shifts or shifts_kwargs must be provided.

Returns
-------
Expand Down Expand Up @@ -2791,7 +2791,7 @@ def roll(
deprecated and will change to False in a future version.
Explicitly pass roll_coords to silence the warning.
**shifts_kwargs : The keyword arguments form of ``shifts``.
One of shifts or shifts_kwarg must be provided.
One of shifts or shifts_kwargs must be provided.

Returns
-------
Expand Down
12 changes: 6 additions & 6 deletions xarray/core/dataset.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1887,7 +1887,7 @@ def isel(
drop : bool, optional
If ``drop=True``, drop coordinates variables indexed by integers
instead of making them scalar.
**indexers_kwarg : {dim: indexer, ...}, optional
**indexers_kwargs : {dim: indexer, ...}, optional
The keyword arguments form of ``indexers``.
One of indexers or indexers_kwargs must be provided.
Expand Down Expand Up @@ -2033,7 +2033,7 @@ def sel(
drop : bool, optional
If ``drop=True``, drop coordinates variables in `indexers` instead
of making them scalar.
**indexers_kwarg : {dim: indexer, ...}, optional
**indexers_kwargs : {dim: indexer, ...}, optional
The keyword arguments form of ``indexers``.
One of indexers or indexers_kwargs must be provided.
Expand Down Expand Up @@ -2168,7 +2168,7 @@ def thin(
Parameters
----------
indexers : dict or int, default: 5
indexers : dict or int
A dict with keys matching dimensions and integer values `n`
or a single integer `n` applied over all dimensions.
One of indexers or indexers_kwargs must be provided.
Expand Down Expand Up @@ -2332,7 +2332,7 @@ def reindex(
fill_value : scalar, optional
Value to use for newly missing values
sparse: use sparse-array. By default, False
**indexers_kwarg : {dim: indexer, ...}, optional
**indexers_kwargs : {dim: indexer, ...}, optional
Keyword arguments in the same form as ``indexers``.
One of indexers or indexers_kwargs must be provided.
Expand Down Expand Up @@ -2547,7 +2547,7 @@ def interp(
values.
kwargs: dictionary, optional
Additional keyword passed to scipy's interpolator.
**coords_kwarg : {dim: coordinate, ...}, optional
**coords_kwargs : {dim: coordinate, ...}, optional
The keyword arguments form of ``coords``.
One of coords or coords_kwargs must be provided.
Expand Down Expand Up @@ -4938,7 +4938,7 @@ def shift(self, shifts=None, fill_value=dtypes.NA, **shifts_kwargs):
Value to use for newly missing values
**shifts_kwargs:
The keyword arguments form of ``shifts``.
One of shifts or shifts_kwarg must be provided.
One of shifts or shifts_kwargs must be provided.
Returns
-------
Expand Down
4 changes: 2 additions & 2 deletions xarray/core/variable.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1137,7 +1137,7 @@ def shift(self, shifts=None, fill_value=dtypes.NA, **shifts_kwargs):
Value to use for newly missing values
**shifts_kwargs:
The keyword arguments form of ``shifts``.
One of shifts or shifts_kwarg must be provided.
One of shifts or shifts_kwargs must be provided.
Returns
-------
Expand Down Expand Up @@ -1245,7 +1245,7 @@ def roll(self, shifts=None, **shifts_kwargs):
left.
**shifts_kwargs:
The keyword arguments form of ``shifts``.
One of shifts or shifts_kwarg must be provided.
One of shifts or shifts_kwargs must be provided.
Returns
-------
Expand Down