Skip to content

Improve where docstring #3836

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

Merged
max-sixty merged 5 commits into from
Mar 19, 2020
Merged

Improve where docstring #3836

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
9cead14
improve the where docstring
max-sixty Mar 6, 2020
e162704
whatsnew
max-sixty Mar 6, 2020
c0bcd1f
improve assign docstring
max-sixty Mar 6, 2020
17d3e71
Merge branch 'master' into where-docstring
max-sixty Mar 15, 2020
7bbd7a6
changes from @dcherian
max-sixty Mar 19, 2020
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
2 changes: 2 additions & 0 deletions doc/whats-new.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,8 @@ Documentation
- Fix documentation of :py:class:`DataArray` removing the deprecated mention
that when omitted, `dims` are inferred from a `coords`-dict. (:pull:`3821`)
By `Sander van Rijn <https://github.com/sjvrijn>`_.
- Improve the :py:func:`where` docstring.
By `Maximilian Roos <https://github.com/max-sixty>`_

Internal Changes
~~~~~~~~~~~~~~~~
Expand Down
18 changes: 11 additions & 7 deletions xarray/core/computation.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1225,14 +1225,18 @@ def where(cond, x, y):
----------
cond : scalar, array, Variable, DataArray or Dataset with boolean dtype
When True, return values from `x`, otherwise returns values from `y`.
x, y : scalar, array, Variable, DataArray or Dataset
Values from which to choose. All dimension coordinates on these objects
must be aligned with each other and with `cond`.
x : scalar, array, Variable, DataArray or Dataset
values to choose from where `cond` is True
y : scalar, array, Variable, DataArray or Dataset
values to choose from where `cond` is False

All dimension coordinates on these objects must be aligned with each
other and with `cond`.

Returns
-------
In priority order: Dataset, DataArray, Variable or array, whichever
type appears as an input argument.
Dataset, DataArray, Variable or array, whichever type appears as an input
argument.

Examples
--------
Expand All @@ -1246,13 +1250,13 @@ def where(cond, x, y):
Coordinates:
* lat (lat) int64 0 1 2 3 4 5 6 7 8 9

>>> xr.where(x < 0.5, x, 100*x)
>>> xr.where(x < 0.5, x, x * 100)
<xarray.DataArray 'sst' (lat: 10)>
array([ 0. , 0.1, 0.2, 0.3, 0.4, 50. , 60. , 70. , 80. , 90. ])
Coordinates:
* lat (lat) int64 0 1 2 3 4 5 6 7 8 9

>>> >>> y = xr.DataArray(
>>> y = xr.DataArray(
... 0.1 * np.arange(9).reshape(3, 3),
... dims=["lat", "lon"],
... coords={"lat": np.arange(3), "lon": 10 + np.arange(3)},
Expand Down
4 changes: 1 addition & 3 deletions xarray/core/dataset.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4362,8 +4362,6 @@ def assign(

Examples
--------
>>> import numpy as np
>>> import xarray as xr
>>> x = xr.Dataset(
... {
... "temperature_c": (("lat", "lon"), 20 * np.random.rand(4).reshape(2, 2)),
Expand All @@ -4383,7 +4381,7 @@ def assign(

Where the value is a callable, evaluated on dataset:

>>> x.assign(temperature_f = lambda x: x.temperature_c * 9 / 5 + 32)
>>> x.assign(temperature_f=lambda x: x.temperature_c * 9 / 5 + 32)
<xarray.Dataset>
Dimensions: (lat: 2, lon: 2)
Coordinates:
Expand Down