Skip to content

Commit 0cd70de

Browse files
committed
DOC: Improve what the axis= kwarg does for generic methods
- Fix #29203
1 parent 8df8c45 commit 0cd70de

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

pandas/core/generic.py

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10726,7 +10726,7 @@ def all(self, axis=0, bool_only=None, skipna=True, level=None, **kwargs):
1072610726

1072710727
@doc(
1072810728
desc="Return the mean absolute deviation of the values "
10729-
"for the requested axis.",
10729+
"over the requested axis.",
1073010730
name1=name1,
1073110731
name2=name2,
1073210732
axis_descr=axis_descr,
@@ -10862,7 +10862,7 @@ def cumprod(self, axis=None, skipna=True, *args, **kwargs):
1086210862

1086310863
@doc(
1086410864
_num_doc,
10865-
desc="Return the sum of the values for the requested axis.\n\n"
10865+
desc="Return the sum of the values over the requested axis.\n\n"
1086610866
"This is equivalent to the method ``numpy.sum``.",
1086710867
name1=name1,
1086810868
name2=name2,
@@ -10888,7 +10888,7 @@ def sum(
1088810888

1088910889
@doc(
1089010890
_num_doc,
10891-
desc="Return the product of the values for the requested axis.",
10891+
desc="Return the product of the values over the requested axis.",
1089210892
name1=name1,
1089310893
name2=name2,
1089410894
axis_descr=axis_descr,
@@ -10914,7 +10914,7 @@ def prod(
1091410914

1091510915
@doc(
1091610916
_num_doc,
10917-
desc="Return the mean of the values for the requested axis.",
10917+
desc="Return the mean of the values over the requested axis.",
1091810918
name1=name1,
1091910919
name2=name2,
1092010920
axis_descr=axis_descr,
@@ -10963,7 +10963,7 @@ def kurt(self, axis=None, skipna=None, level=None, numeric_only=None, **kwargs):
1096310963

1096410964
@doc(
1096510965
_num_doc,
10966-
desc="Return the median of the values for the requested axis.",
10966+
desc="Return the median of the values over the requested axis.",
1096710967
name1=name1,
1096810968
name2=name2,
1096910969
axis_descr=axis_descr,
@@ -10980,7 +10980,7 @@ def median(
1098010980

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

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

0 commit comments

Comments
 (0)