Skip to content

Commit

Permalink
Update where docstring to make return value type more clear (#3408)
Browse files Browse the repository at this point in the history
* Update where docstring to make return value type more clear

The where docstring was a little confusing to me.  I misunderstood "Same type as caller' to mean the values in the xarray not the xarray itself.  I think this small change will clean it up for most users.  Thanks.

* Update xarray/core/common.py

Co-Authored-By: Maximilian Roos <5635139+max-sixty@users.noreply.github.com>
  • Loading branch information
2 people authored and dcherian committed Oct 17, 2019
1 parent 55b1ac0 commit 6cd50cc
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion xarray/core/common.py
Original file line number Diff line number Diff line change
Expand Up @@ -1069,7 +1069,7 @@ def where(self, cond, other=dtypes.NA, drop: bool = False):
Returns
-------
Same type as caller.
Same xarray type as caller, with dtype float64.
Examples
--------
Expand Down

0 comments on commit 6cd50cc

Please sign in to comment.