From 497ede8065e81065636908fecd31432a91c1ff64 Mon Sep 17 00:00:00 2001 From: timhunderwood <43515959+timhunderwood@users.noreply.github.com> Date: Thu, 3 Sep 2020 17:58:36 +0100 Subject: [PATCH] DOC: Add Notes about difference to numpy behaviour for ddof in std() GH35985 (#35986) * DOC: Add Notes about difference to numpy behaviour for ddof. GH35985. * remove trailing whitespace. * Update pandas/core/generic.py wording change. Co-authored-by: Daniel Saxton <2658661+dsaxton@users.noreply.github.com> * Make wording simpler and remove reference to normalization. * Make wording simpler and remove reference to normalization. Co-authored-by: Daniel Saxton <2658661+dsaxton@users.noreply.github.com> --- pandas/core/generic.py | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/pandas/core/generic.py b/pandas/core/generic.py index e22f9567ee955..6c8780a0fc186 100644 --- a/pandas/core/generic.py +++ b/pandas/core/generic.py @@ -10832,7 +10832,12 @@ def _doc_parms(cls): Returns ------- -%(name1)s or %(name2)s (if level specified)\n""" +%(name1)s or %(name2)s (if level specified) + +Notes +----- +To have the same behaviour as `numpy.std`, use `ddof=0` (instead of the +default `ddof=1`)\n""" _bool_doc = """ %(desc)s