Skip to content

DOC: Only include numpy.std note for std, not all ddof methods #42290

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 13, 2021
Merged

DOC: Only include numpy.std note for std, not all ddof methods #42290

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions pandas/core/generic.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10557,6 +10557,7 @@ def mad(self, axis=None, skipna=None, level=None):
name1=name1,
name2=name2,
axis_descr=axis_descr,
notes="",
)
def sem(
self,
Expand All @@ -10578,6 +10579,7 @@ def sem(
name1=name1,
name2=name2,
axis_descr=axis_descr,
notes="",
)
def var(
self,
Expand All @@ -10600,6 +10602,7 @@ def var(
name1=name1,
name2=name2,
axis_descr=axis_descr,
notes=_std_notes,
)
def std(
self,
Expand Down Expand Up @@ -11090,12 +11093,16 @@ def _doc_params(cls):

Returns
-------
{name1} or {name2} (if level specified)
{name1} or {name2} (if level specified) \
{notes}
"""

_std_notes = """

Notes
-----
To have the same behaviour as `numpy.std`, use `ddof=0` (instead of the
default `ddof=1`)\n"""
default `ddof=1`)"""

_bool_doc = """
{desc}
Expand Down