Skip to content

Commit 686560a

Browse files
committed
DOC: Improve what the axis= kwarg does for generic methods
- Fix #29203
1 parent 3a043f2 commit 686560a

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
@@ -10433,7 +10433,7 @@ def _add_numeric_operations(cls):
1043310433

1043410434
@doc(
1043510435
desc="Return the mean absolute deviation of the values "
10436-
"for the requested axis.",
10436+
"across the requested axis.",
1043710437
name1=name1,
1043810438
name2=name2,
1043910439
axis_descr=axis_descr,
@@ -10560,7 +10560,7 @@ def mad(self, axis=None, skipna=None, level=None):
1056010560
name1=name1,
1056110561
name2=name2,
1056210562
axis_descr=axis_descr,
10563-
desc="Return the sum of the values for the requested axis.\n\n"
10563+
desc="Return the sum of the values across the requested axis.\n\n"
1056410564
"This is equivalent to the method ``numpy.sum``.",
1056510565
func=nanops.nansum,
1056610566
see_also=_stat_func_see_also,
@@ -10572,7 +10572,7 @@ def mad(self, axis=None, skipna=None, level=None):
1057210572
name1=name1,
1057310573
name2=name2,
1057410574
axis_descr=axis_descr,
10575-
desc="Return the mean of the values for the requested axis.",
10575+
desc="Return the mean of the values across the requested axis.",
1057610576
func=nanops.nanmean,
1057710577
)
1057810578
cls.skew = _make_stat_function(
@@ -10603,7 +10603,7 @@ def mad(self, axis=None, skipna=None, level=None):
1060310603
name1=name1,
1060410604
name2=name2,
1060510605
axis_descr=axis_descr,
10606-
desc="Return the product of the values for the requested axis.",
10606+
desc="Return the product of the values across the requested axis.",
1060710607
func=nanops.nanprod,
1060810608
examples=_prod_examples,
1060910609
)
@@ -10614,7 +10614,7 @@ def mad(self, axis=None, skipna=None, level=None):
1061410614
name1=name1,
1061510615
name2=name2,
1061610616
axis_descr=axis_descr,
10617-
desc="Return the median of the values for the requested axis.",
10617+
desc="Return the median of the values across the requested axis.",
1061810618
func=nanops.nanmedian,
1061910619
)
1062010620
cls.max = _make_stat_function(
@@ -10623,7 +10623,7 @@ def mad(self, axis=None, skipna=None, level=None):
1062310623
name1=name1,
1062410624
name2=name2,
1062510625
axis_descr=axis_descr,
10626-
desc="Return the maximum of the values for the requested axis.\n\n"
10626+
desc="Return the maximum of the values across the requested axis.\n\n"
1062710627
"If you want the *index* of the maximum, use ``idxmax``. This is"
1062810628
"the equivalent of the ``numpy.ndarray`` method ``argmax``.",
1062910629
func=nanops.nanmax,
@@ -10636,7 +10636,7 @@ def mad(self, axis=None, skipna=None, level=None):
1063610636
name1=name1,
1063710637
name2=name2,
1063810638
axis_descr=axis_descr,
10639-
desc="Return the minimum of the values for the requested axis.\n\n"
10639+
desc="Return the minimum of the values across the requested axis.\n\n"
1064010640
"If you want the *index* of the minimum, use ``idxmin``. This is"
1064110641
"the equivalent of the ``numpy.ndarray`` method ``argmin``.",
1064210642
func=nanops.nanmin,

0 commit comments

Comments
 (0)