Skip to content

Commit

Permalink
DOC: Improve what the axis= kwarg does for generic methods (#37029)
Browse files Browse the repository at this point in the history
  • Loading branch information
hongshaoyang authored Oct 12, 2020
1 parent 79c8a2a commit efa80f3
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions pandas/core/generic.py
Original file line number Diff line number Diff line change
Expand Up @@ -10724,7 +10724,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 @@ -10860,7 +10860,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 @@ -10886,7 +10886,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 @@ -10912,7 +10912,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 @@ -10961,7 +10961,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 @@ -10978,7 +10978,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 @@ -10995,7 +10995,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

0 comments on commit efa80f3

Please sign in to comment.