Skip to content

DOC: Improve documentation for Index.where #32009

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
merged 6 commits into from
Feb 26, 2020
Merged

DOC: Improve documentation for Index.where #32009

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
d7d23ca
DOC: SA01 Add See Also section in Index.where
laymonage Feb 15, 2020
1586cc0
DOC: PR07 Add descriptions for Index.where parameters
laymonage Feb 15, 2020
abeaf01
DOC: RT03 Add return value description for Index.where
laymonage Feb 15, 2020
2d7af91
DOC: SS06 Make summary for Index.where fit in one line
laymonage Feb 15, 2020
49c0c8d
DOC: EX01 Add Examples section in Index.where
laymonage Feb 15, 2020
90c00c7
DOC: Improve documentation for Index.where
laymonage Feb 23, 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
27 changes: 22 additions & 5 deletions pandas/core/indexes/base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3936,18 +3936,35 @@ def memory_usage(self, deep: bool = False) -> int:

def where(self, cond, other=None):
"""
Return an Index of same shape as self and whose corresponding
entries are from self where cond is True and otherwise are from
other.
Replace values where the condition is False.

The replacement is taken from other.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think this whole description is very clear. May be you can simply mention in the short summary this is a conditional. And explain what exactly does in the extended summary.

Copy link
Contributor Author

@laymonage laymonage Feb 23, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay, I've copied the short summary from Series.where and DataFrame.where.


Parameters
----------
cond : bool array-like with the same length as self
other : scalar, or array-like
Condition to select the values on.
other : scalar, or array-like, default None
Replacement if the condition is False.

Returns
-------
Index
pandas.Index
A copy of self with values replaced from other
where the condition is False.

See Also
--------
Series.where : Same method for Series.
DataFrame.where : Same method for DataFrame.

Examples
--------
>>> idx = pd.Index(['car', 'bike', 'train', 'tractor'])
>>> idx
Index(['car', 'bike', 'train', 'tractor'], dtype='object')
>>> idx.where(idx.isin(['car', 'train']), 'other')
Index(['car', 'other', 'train', 'other'], dtype='object')
"""
if other is None:
other = self._na_value
Expand Down