Skip to content

DOC: Improve what the axis= kwarg does for generic methods #37029

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

Merged
merged 3 commits into from
Oct 12, 2020
Merged

DOC: Improve what the axis= kwarg does for generic methods #37029

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0cd70de
DOC: Improve what the `axis=` kwarg does for generic methods
hongshaoyang Oct 10, 2020
072c59a
Merge branch 'master' into personal/shaoyang
hongshaoyang Oct 11, 2020
bd3ffa7
Merge branch 'master' into personal/shaoyang
hongshaoyang Oct 12, 2020
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
14 changes: 7 additions & 7 deletions pandas/core/generic.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10732,7 +10732,7 @@ def all(self, axis=0, bool_only=None, skipna=True, level=None, **kwargs):

@doc(
desc="Return the mean absolute deviation of the values "
"for the requested axis.",
"over the requested axis.",
name1=name1,
name2=name2,
axis_descr=axis_descr,
Expand Down Expand Up @@ -10868,7 +10868,7 @@ def cumprod(self, axis=None, skipna=True, *args, **kwargs):

@doc(
_num_doc,
desc="Return the sum of the values for the requested axis.\n\n"
desc="Return the sum of the values over the requested axis.\n\n"
"This is equivalent to the method ``numpy.sum``.",
name1=name1,
name2=name2,
Expand All @@ -10894,7 +10894,7 @@ def sum(

@doc(
_num_doc,
desc="Return the product of the values for the requested axis.",
desc="Return the product of the values over the requested axis.",
name1=name1,
name2=name2,
axis_descr=axis_descr,
Expand All @@ -10920,7 +10920,7 @@ def prod(

@doc(
_num_doc,
desc="Return the mean of the values for the requested axis.",
desc="Return the mean of the values over the requested axis.",
name1=name1,
name2=name2,
axis_descr=axis_descr,
Expand Down Expand Up @@ -10969,7 +10969,7 @@ def kurt(self, axis=None, skipna=None, level=None, numeric_only=None, **kwargs):

@doc(
_num_doc,
desc="Return the median of the values for the requested axis.",
desc="Return the median of the values over the requested axis.",
name1=name1,
name2=name2,
axis_descr=axis_descr,
Expand All @@ -10986,7 +10986,7 @@ def median(

@doc(
_num_doc,
desc="Return the maximum of the values for the requested axis.\n\n"
desc="Return the maximum of the values over the requested axis.\n\n"
"If you want the *index* of the maximum, use ``idxmax``. This is"
"the equivalent of the ``numpy.ndarray`` method ``argmax``.",
name1=name1,
Expand All @@ -11003,7 +11003,7 @@ def max(self, axis=None, skipna=None, level=None, numeric_only=None, **kwargs):

@doc(
_num_doc,
desc="Return the minimum of the values for the requested axis.\n\n"
desc="Return the minimum of the values over the requested axis.\n\n"
"If you want the *index* of the minimum, use ``idxmin``. This is"
"the equivalent of the ``numpy.ndarray`` method ``argmin``.",
name1=name1,
Expand Down