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 <[email protected]> * Make wording simpler and remove reference to normalization. * Make wording simpler and remove reference to normalization. Co-authored-by: Daniel Saxton <[email protected]>
pandas-dev · Sep 3, 2020 · 497ede8 · 497ede8
1 parent f3408ea
commit 497ede8
Showing 1 changed file with 6 additions and 1 deletion.
diff --git 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