Skip to content

Commit fdb10e0

Browse files
kawochenjreback
authored andcommitted
DOC: Remove claims of unbiasedness from doc string for std
xref #12230 Author: Ka Wo Chen <kawoc@tepper.cmu.edu> Closes #12234 from kawochen/DOC-std and squashes the following commits: d224abb [Ka Wo Chen] DOC: Improve doc string for std
1 parent 0d3d0a4 commit fdb10e0

File tree

3 files changed

+8
-8
lines changed

3 files changed

+8
-8
lines changed

doc/source/basics.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -483,11 +483,11 @@ optional ``level`` parameter which applies only if the object has a
483483
``mode``, Mode
484484
``abs``, Absolute Value
485485
``prod``, Product of values
486-
``std``, Unbiased standard deviation
486+
``std``, Bessel-corrected sample standard deviation
487487
``var``, Unbiased variance
488-
``sem``, Unbiased standard error of the mean
489-
``skew``, Unbiased skewness (3rd moment)
490-
``kurt``, Unbiased kurtosis (4th moment)
488+
``sem``, Standard error of the mean
489+
``skew``, Sample skewness (3rd moment)
490+
``kurt``, Sample kurtosis (4th moment)
491491
``quantile``, Sample quantile (value at %)
492492
``cumsum``, Cumulative sum
493493
``cumprod``, Cumulative product

doc/source/computation.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -309,10 +309,10 @@ We provide a number of the common statistical functions:
309309
:meth:`~Rolling.median`, Arithmetic median of values
310310
:meth:`~Rolling.min`, Minimum
311311
:meth:`~Rolling.max`, Maximum
312-
:meth:`~Rolling.std`, Unbiased standard deviation
312+
:meth:`~Rolling.std`, Bessel-corrected sample standard deviation
313313
:meth:`~Rolling.var`, Unbiased variance
314-
:meth:`~Rolling.skew`, Unbiased skewness (3rd moment)
315-
:meth:`~Rolling.kurt`, Unbiased kurtosis (4th moment)
314+
:meth:`~Rolling.skew`, Sample skewness (3rd moment)
315+
:meth:`~Rolling.kurt`, Sample kurtosis (4th moment)
316316
:meth:`~Rolling.quantile`, Sample quantile (value at %)
317317
:meth:`~Rolling.apply`, Generic apply
318318
:meth:`~Rolling.cov`, Unbiased covariance (binary)

pandas/core/generic.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4783,7 +4783,7 @@ def mad(self, axis=None, skipna=None, level=None):
47834783
nanops.nanvar)
47844784
cls.std = _make_stat_function_ddof(
47854785
'std', name, name2, axis_descr,
4786-
"Return unbiased standard deviation over requested axis."
4786+
"Return sample standard deviation over requested axis."
47874787
"\n\nNormalized by N-1 by default. This can be changed using the "
47884788
"ddof argument",
47894789
nanops.nanstd)

0 commit comments

Comments
 (0)