Skip to content

Commit ccf2a27

Browse files
hongshaoyangJulianWgs
authored andcommitted
DOC: Improve what the axis= kwarg does for generic methods (pandas-dev#37029)
1 parent 1a1caae commit ccf2a27

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

pandas/core/generic.py

+7-7
Original file line numberDiff line numberDiff line change
@@ -10724,7 +10724,7 @@ def all(self, axis=0, bool_only=None, skipna=True, level=None, **kwargs):
1072410724

1072510725
@doc(
1072610726
desc="Return the mean absolute deviation of the values "
10727-
"for the requested axis.",
10727+
"over the requested axis.",
1072810728
name1=name1,
1072910729
name2=name2,
1073010730
axis_descr=axis_descr,
@@ -10860,7 +10860,7 @@ def cumprod(self, axis=None, skipna=True, *args, **kwargs):
1086010860

1086110861
@doc(
1086210862
_num_doc,
10863-
desc="Return the sum of the values for the requested axis.\n\n"
10863+
desc="Return the sum of the values over the requested axis.\n\n"
1086410864
"This is equivalent to the method ``numpy.sum``.",
1086510865
name1=name1,
1086610866
name2=name2,
@@ -10886,7 +10886,7 @@ def sum(
1088610886

1088710887
@doc(
1088810888
_num_doc,
10889-
desc="Return the product of the values for the requested axis.",
10889+
desc="Return the product of the values over the requested axis.",
1089010890
name1=name1,
1089110891
name2=name2,
1089210892
axis_descr=axis_descr,
@@ -10912,7 +10912,7 @@ def prod(
1091210912

1091310913
@doc(
1091410914
_num_doc,
10915-
desc="Return the mean of the values for the requested axis.",
10915+
desc="Return the mean of the values over the requested axis.",
1091610916
name1=name1,
1091710917
name2=name2,
1091810918
axis_descr=axis_descr,
@@ -10961,7 +10961,7 @@ def kurt(self, axis=None, skipna=None, level=None, numeric_only=None, **kwargs):
1096110961

1096210962
@doc(
1096310963
_num_doc,
10964-
desc="Return the median of the values for the requested axis.",
10964+
desc="Return the median of the values over the requested axis.",
1096510965
name1=name1,
1096610966
name2=name2,
1096710967
axis_descr=axis_descr,
@@ -10978,7 +10978,7 @@ def median(
1097810978

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

1099610996
@doc(
1099710997
_num_doc,
10998-
desc="Return the minimum of the values for the requested axis.\n\n"
10998+
desc="Return the minimum of the values over the requested axis.\n\n"
1099910999
"If you want the *index* of the minimum, use ``idxmin``. This is"
1100011000
"the equivalent of the ``numpy.ndarray`` method ``argmin``.",
1100111001
name1=name1,

0 commit comments

Comments
 (0)