Skip to content

DOC: Remove claims of unbiasedness from doc string for std #12234

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

Closed
wants to merge 1 commit into from
Closed

DOC: Remove claims of unbiasedness from doc string for std #12234

Show file tree
Hide file tree
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
8 changes: 4 additions & 4 deletions doc/source/basics.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -483,11 +483,11 @@ optional ``level`` parameter which applies only if the object has a
``mode``, Mode
``abs``, Absolute Value
``prod``, Product of values
``std``, Unbiased standard deviation
``std``, Bessel-corrected sample standard deviation
``var``, Unbiased variance
``sem``, Unbiased standard error of the mean
``skew``, Unbiased skewness (3rd moment)
``kurt``, Unbiased kurtosis (4th moment)
``sem``, Standard error of the mean
``skew``, Sample skewness (3rd moment)
``kurt``, Sample kurtosis (4th moment)
``quantile``, Sample quantile (value at %)
``cumsum``, Cumulative sum
``cumprod``, Cumulative product
Expand Down
6 changes: 3 additions & 3 deletions doc/source/computation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -309,10 +309,10 @@ We provide a number of the common statistical functions:
:meth:`~Rolling.median`, Arithmetic median of values
:meth:`~Rolling.min`, Minimum
:meth:`~Rolling.max`, Maximum
:meth:`~Rolling.std`, Unbiased standard deviation
:meth:`~Rolling.std`, Bessel-corrected sample standard deviation
:meth:`~Rolling.var`, Unbiased variance
:meth:`~Rolling.skew`, Unbiased skewness (3rd moment)
:meth:`~Rolling.kurt`, Unbiased kurtosis (4th moment)
:meth:`~Rolling.skew`, Sample skewness (3rd moment)
:meth:`~Rolling.kurt`, Sample kurtosis (4th moment)
:meth:`~Rolling.quantile`, Sample quantile (value at %)
:meth:`~Rolling.apply`, Generic apply
:meth:`~Rolling.cov`, Unbiased covariance (binary)
Expand Down
2 changes: 1 addition & 1 deletion pandas/core/generic.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4783,7 +4783,7 @@ def mad(self, axis=None, skipna=None, level=None):
nanops.nanvar)
cls.std = _make_stat_function_ddof(
'std', name, name2, axis_descr,
"Return unbiased standard deviation over requested axis."
"Return sample standard deviation over requested axis."
"\n\nNormalized by N-1 by default. This can be changed using the "
"ddof argument",
nanops.nanstd)
Expand Down