DOC: Docstring for pandas.index.max

[JoanMartin]

Checklist for the pandas documentation sprint (ignore this if you are doing
an unrelated PR):

• PR title is "DOC: update the docstring"
• The validation script passes: scripts/validate_docstrings.py <your-function-or-method>
• The PEP8 style check passes: git diff upstream/master -u -- "*.py" | flake8 --diff
• The html version looks good: python doc/make.py --single <your-function-or-method>
• It has been proofread on language by another sprint participant

Please include the output of the validation script below between the "```" ticks:

################################################################################
######################### Docstring (pandas.Index.max) #########################
################################################################################

Return the maximum value of the object.

Return the maximum value of the object within the same type.

Returns
-------
scalar
    Maximum value.

See Also
--------
Series.max : Return the maximum value of the object.
DataFrame.max : Return the maximum value of the object.
Index.min : Return the minimum value of the object.

Examples
--------
>>> idx = pd.Index([3, 2, 1])
>>> idx.max()
3

>>> idx = pd.Index(['c', 'b', 'a'])
>>> idx.max()
'c'

################################################################################
################################## Validation ##################################
################################################################################

Docstring for "pandas.Index.max" correct. :)

If the validation script still gives errors, but you think there is a good reason
to deviate in this case (and there are certainly such cases), please state this
explicitly.

[jcorrius]

This sentence may need some rewording

[rafarui]

I would rewrite the last sentence to:
The DataFrame Index can be accessed using pandas.DataFrame.index.

[JoanMartin]

Thanks! :)

[caperutxa]

Looks so nice

[jreback]

this last sentence is unecessary

[jreback]

scalar

[jreback]

link to Series.max, DataFrame.max

[JoanMartin]

Thanks! =)

[JoanMartin]

Hi @jreback,
is the commit correct now? =)

[codecov]

Codecov Report

❗ No coverage uploaded for pull request base (master@fb556ed). Click here to learn what that means.
The diff coverage is n/a.

@@            Coverage Diff            @@
##             master   #20130   +/-   ##
=========================================
  Coverage          ?   91.72%           
=========================================
  Files             ?      150           
  Lines             ?    49152           
  Branches          ?        0           
=========================================
  Hits              ?    45086           
  Misses            ?     4066           
  Partials          ?        0

Flag	Coverage Δ
#multiple	90.11% <ø> (?)
#single	41.84% <ø> (?)

Impacted Files	Coverage Δ
pandas/core/base.py	96.78% <ø> (ø)

---

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 fb556ed...ba435c2. Read the comment docs.

[TomAugspurger]

Thanks @JoanMartin 👍