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

[ksasi]

• PR title is "DOC: update the docstring"
• closes DOC: update the pd.Index.contains docstring #20211
• passes git diff upstream/master -u -- "*.py" | flake8 --diff

The following is added for the doc string :
"""
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
     """

The suggestions mentioned in the pull request#20211 were followed. Probably this can help close pull request#20211.

[pep8speaks]

Hello @ksasi! Thanks for updating the PR.

• There are no PEP8 issues in the file pandas/core/indexes/base.py !

Comment last updated on October 08, 2018 at 09:04 Hours UTC

[codecov]

Codecov Report

Merging #23039 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master   #23039   +/-   ##
=======================================
  Coverage   92.19%   92.19%           
=======================================
  Files         169      169           
  Lines       50873    50873           
=======================================
  Hits        46904    46904           
  Misses       3969     3969

Flag	Coverage Δ
#multiple	90.61% <ø> (ø)	⬆️
#single	42.32% <ø> (ø)	⬆️

Impacted Files	Coverage Δ
pandas/core/indexes/base.py	96.54% <ø> (ø)	⬆️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update ce1f81f...51f8539. Read the comment docs.

[datapythonista]

Sorry about it @ksasi, but @Tanya-Jain has been working with me in the final changes for this PR during the sprint, and she's got very good work that she will be submitting soon. I know it's frustraiting to have to discard work, but we need to be more careful on avoiding overlap. Try checking the last comments of the issue (or PR) and make sure nobody said is already working on it.

Hope to see you tomorrow in the sprint, and let's see if we can coordinate better then. :)

[ksasi]

sure, np @datapythonista .Thanks for letting me know, I will try to work on any other open/pending items that might help.