DOC: Docstring pandas index all any

[alinde1]

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.any) #########################
################################################################################

Return whether any element is True.

Parameters
----------
*args
    These parameters will be passed to numpy.any.
**kwargs
    These parameters will be passed to numpy.any.

Returns
-------
any : bool or array_like (if axis is specified)
    A single element array_like may be converted to bool.

        See Also
        --------
        pandas.Index.all : Return whether all elements are True.

        Notes
        -----
        Not a Number (NaN), positive infinity and negative infinity
        evaluate to True because these are not equal to zero.

        Examples
        --------
        >>> index = pd.Index([0, 1, 2])
        >>> index.any()
        True

        >>> index = pd.Index([0, 0, 0])
        >>> index.any()
        False

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

Errors found:
        No extended summary found
        Errors in parameters section
                Parameters {'args', 'kwargs'} not documented
                Unknown parameters {'**kwargs', '*args'}
                Parameter "*args" has no type
                Parameter "**kwargs" has no type

################################################################################
######################### Docstring (pandas.Index.all) #########################
################################################################################

Return whether all elements are True.

Parameters
----------
*args
    These parameters will be passed to numpy.all.
**kwargs
    These parameters will be passed to numpy.all.

Returns
-------
all : bool or array_like (if axis is specified)
    A single element array_like may be converted to bool.

        See Also
        --------
        pandas.Index.any : Return whether any element is True.

        Notes
        -----
        Not a Number (NaN), positive infinity and negative infinity
        evaluate to True because these are not equal to zero.

        Examples
        --------
        >>> index = pd.Index([1, 2, 3])
        >>> index.all()
        True

        >>> index = pd.Index([0, 1, 2])
        >>> index.all()
        False

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

Errors found:
        No extended summary found
        Errors in parameters section
                Parameters {'kwargs', 'args'} not documented
                Unknown parameters {'**kwargs', '*args'}
                Parameter "*args" has no type
                Parameter "**kwargs" has no type

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.

[TomAugspurger]

Can you past the final docstring once the subs have been made? I'm trying to udnerstand outnames

[TomAugspurger]

PEP8: space after commas

[alinde1]

################################################################################
######################### Docstring (pandas.Index.all) #########################
################################################################################

Return whether all elements are True.

Parameters

*args
These parameters will be passed to numpy.all.
**kwargs
These parameters will be passed to numpy.all.

Returns

all : bool or array_like (if axis is specified)
A single element array_like may be converted to bool.

    See Also
    --------
    pandas.Index.any : Return whether any element is True.

    Notes
    -----
    Not a Number (NaN), positive infinity and negative infinity
    evaluate to True because these are not equal to zero.

    Examples
    --------
    >>> index = pd.Index([1, 2, 3])
    >>> index.all()
    True

    >>> index = pd.Index([0, 1, 2])
    >>> index.all()
    False

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

Errors found:
No extended summary found
Errors in parameters section
Parameters {'kwargs', 'args'} not documented
Unknown parameters {'**kwargs', '*args'}
Parameter "*args" has no type
Parameter "**kwargs" has no type

[jreback]

pandas.Series.any as well

[jreback]

pandas.Series.all

[codecov]

Codecov Report

❗ No coverage uploaded for pull request base (master@ec631ce). Click here to learn what that means.
The diff coverage is 100%.

@@            Coverage Diff            @@
##             master   #20168   +/-   ##
=========================================
  Coverage          ?   91.72%           
=========================================
  Files             ?      150           
  Lines             ?    49155           
  Branches          ?        0           
=========================================
  Hits              ?    45089           
  Misses            ?     4066           
  Partials          ?        0

Flag	Coverage Δ
#multiple	90.11% <100%> (?)
#single	41.85% <100%> (?)

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

---

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 ec631ce...23c2c3d. Read the comment docs.

[TomAugspurger]

Thanks @alinde1!