Skip to content

DOC: Improved the docstring of Series.any() #20078

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 5 commits into from
Closed

DOC: Improved the docstring of Series.any() #20078

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
634543f
Merge pull request #1 from pandas-dev/master
FrankDupree Mar 9, 2018
bb3ba08
Merge remote-tracking branch 'upstream/master' into pandas_series_fix
FrankDupree Mar 9, 2018
8303f97
DOC: Improved the docstring of pandas.Series.any
FrankDupree Mar 9, 2018
8737e31
Updates: removed documentation on bug.
FrankDupree Mar 9, 2018
680f48c
DOC: Improved the docstring of Series.any()
FrankDupree Mar 10, 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
26 changes: 21 additions & 5 deletions pandas/core/generic.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7522,7 +7522,7 @@ def _add_numeric_operations(cls):

cls.any = _make_logical_function(
cls, 'any', name, name2, axis_descr,
'Return whether any element is True over requested axis',
'Return whether any element is True over requested axis.',
nanops.nanany)
cls.all = _make_logical_function(
cls, 'all', name, name2, axis_descr,
Expand Down Expand Up @@ -7784,25 +7784,41 @@ def _doc_parms(cls):
%(outname)s : %(name1)s or %(name2)s (if level specified)\n"""

_bool_doc = """

%(desc)s

Returns True if one (or more) elements are non-zero,
not-empty or not-False.

Parameters
----------
axis : %(axis_descr)s
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing description

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(never mind)

skipna : boolean, default True
Exclude NA/null values. If an entire row/column is NA, the result
will be NA
will be NA.
level : int or level name, default None
If the axis is a MultiIndex (hierarchical), count along a
particular level, collapsing into a %(name1)s
particular level, collapsing into a %(name1)s.
bool_only : boolean, default None
Include only boolean columns. If None, will attempt to use everything,
then use only boolean data. Not implemented for Series.
**kwargs : Additional keywords have no effect but might be accepted for
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@datapythonista is this the language generally recommending here?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't see this earlier. I think the description is similar to the ones used in kwargs with similar behavior. But it should go in the next line, as in the other parameters, and in this line simply leave **kwargs

compatibility with numpy.

Returns
-------
%(outname)s : %(name1)s or %(name2)s (if level specified)\n"""
%(outname)s : %(name1)s or %(name2)s (if level specified)

Examples
--------
>>> s1 = pd.Series([1, 2, 3])
>>> s1.any()
True

>>> import numpy as np
>>> s2 = pd.Series([np.NaN, np.NaN, np.NaN])
>>> s2.any()
False
"""

_cnum_doc = """

Expand Down