Skip to content

Commit 3c10f1f

Browse files
authored
DOC: Only include numpy.std() note for std(), not all ddof (#42290)
1 parent 25069e0 commit 3c10f1f

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

pandas/core/generic.py

+9-2
Original file line numberDiff line numberDiff line change
@@ -10499,6 +10499,7 @@ def mad(self, axis=None, skipna=None, level=None):
1049910499
name1=name1,
1050010500
name2=name2,
1050110501
axis_descr=axis_descr,
10502+
notes="",
1050210503
)
1050310504
def sem(
1050410505
self,
@@ -10520,6 +10521,7 @@ def sem(
1052010521
name1=name1,
1052110522
name2=name2,
1052210523
axis_descr=axis_descr,
10524+
notes="",
1052310525
)
1052410526
def var(
1052510527
self,
@@ -10542,6 +10544,7 @@ def var(
1054210544
name1=name1,
1054310545
name2=name2,
1054410546
axis_descr=axis_descr,
10547+
notes=_std_notes,
1054510548
)
1054610549
def std(
1054710550
self,
@@ -11034,12 +11037,16 @@ def _doc_params(cls):
1103411037
1103511038
Returns
1103611039
-------
11037-
{name1} or {name2} (if level specified)
11040+
{name1} or {name2} (if level specified) \
11041+
{notes}
11042+
"""
11043+
11044+
_std_notes = """
1103811045
1103911046
Notes
1104011047
-----
1104111048
To have the same behaviour as `numpy.std`, use `ddof=0` (instead of the
11042-
default `ddof=1`)\n"""
11049+
default `ddof=1`)"""
1104311050

1104411051
_bool_doc = """
1104511052
{desc}

0 commit comments

Comments
 (0)