DOC: improve Index docstrings

[abonte]

• xref DOC: Fix EX01 issues in docstrings #37875 and DOC: Fix formatting errors in docstrings #27977
• Tests added and passed if fixing a bug or adding a new feature
• All code checks passed.
• Added type annotations to new arguments/methods/functions.
• Added an entry in the latest doc/source/whatsnew/vX.X.X.rst file if fixing a bug or adding a new feature.

Improve docstring of the following methods:

Index.is_monotonic_increasing

output of scripts/validate_docstrings.py

################################################################################
############### Docstring (pandas.Index.is_monotonic_increasing) ###############
################################################################################

Return a boolean if the values are equal or increasing.

Returns
-------
bool

See Also
--------
Index.is_monotonic_decreasing : Check if the values are equal or decreasing.

Examples
--------
>>> pd.Index([1, 2, 3]).is_monotonic_increasing
True
>>> pd.Index([1, 2, 2]).is_monotonic_increasing
True
>>> pd.Index([1, 3, 2]).is_monotonic_increasing
False

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

1 Errors found:
        No extended summary found

Index.is_monotonic_decreasing

output of scripts/validate_docstrings.py

################################################################################
############### Docstring (pandas.Index.is_monotonic_decreasing) ###############
################################################################################

Return a boolean if the values are equal or decreasing.

Returns
-------
bool

See Also
--------
Index.is_monotonic_increasing : Check if the values are equal or increasing.

Examples
--------
>>> pd.Index([3, 2, 1]).is_monotonic_decreasing
True
>>> pd.Index([3, 2, 2]).is_monotonic_decreasing
True
>>> pd.Index([3, 1, 2]).is_monotonic_decreasing
False

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

1 Errors found:
        No extended summary found

Index.hasnans

output of scripts/validate_docstrings.py

################################################################################
####################### Docstring (pandas.Index.hasnans) #######################
################################################################################

Return True if there are any NaNs.

Enables various performance speedups.

Returns
-------
bool

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

2 Errors found:
        See Also section not found
        No examples section found

Index.has_duplicates

output of scripts/validate_docstrings.py

################################################################################
################### Docstring (pandas.Index.has_duplicates)  ###################
################################################################################

Check if the Index has duplicate values.

Returns
-------
bool
    Whether or not the Index has duplicate values.

See Also
--------
Index.is_unique : Inverse method that checks if it has unique values.

Examples
--------
>>> idx = pd.Index([1, 5, 7, 7])
>>> idx.has_duplicates
True

>>> idx = pd.Index([1, 5, 7])
>>> idx.has_duplicates
False

>>> idx = pd.Index(["Watermelon", "Orange", "Apple",
...                 "Watermelon"]).astype("category")
>>> idx.has_duplicates
True

>>> idx = pd.Index(["Orange", "Apple",
...                 "Watermelon"]).astype("category")
>>> idx.has_duplicates
False

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

1 Errors found:
        No extended summary found

Index.is_unique

output of scripts/validate_docstrings.py

################################################################################
###################### Docstring (pandas.Index.is_unique) ######################
################################################################################

Return if the index has unique values.

Returns
-------
bool

See Also
--------
Index.has_duplicates : Inverse method that checks if it has duplicate values.

Examples
--------
>>> idx = pd.Index([1, 5, 7, 7])
>>> idx.is_unique
False

>>> idx = pd.Index([1, 5, 7])
>>> idx.is_unique
True

>>> idx = pd.Index(["Watermelon", "Orange", "Apple",
...                 "Watermelon"]).astype("category")
>>> idx.is_unique
False

>>> idx = pd.Index(["Orange", "Apple",
...                 "Watermelon"]).astype("category")
>>> idx.is_unique
True

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

1 Errors found:
        No extended summary found

[mroeschke]

According to test_hasnans_uncached_for_series you will need to ensure Series.hasnans has the same docstring as Index.hasnans

[abonte]

@mroeschke
now all checks have passed. Thank you!

[mroeschke]

Thanks @abonte