Skip to content

DOC:Updated as suggested in the comments of PR#20211 #23039

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

Closed
wants to merge 2 commits into from
Closed

DOC:Updated as suggested in the comments of PR#20211 #23039

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
10028e0
Updated as suggested in the comments of PR#20211
Oct 8, 2018
51f8539
Fixed PEP8 issues
Oct 8, 2018
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
16 changes: 15 additions & 1 deletion pandas/core/indexes/base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2005,15 +2005,29 @@ def __contains__(self, key):
return False

_index_shared_docs['contains'] = """
return a boolean if this key is IN the index
Return a boolean if this key is in the index.


Parameters
----------
key : object
key to be searched.

Returns
-------
boolean
result of the search.

See Also
--------
Index.isin

Examples
--------
>>> pd.CategoricalIndex([2000, 2001, 2012]).contains(2001)
True
>>> pd.CategoricalIndex([2000, 2001, 2012]).contains(2222)
False
"""

@Appender(_index_shared_docs['contains'] % _index_doc_kwargs)
Expand Down