DOC ddof not described in docstring.

pydata · Sep 4, 2012 · 1abdfa7 · 1abdfa7
1 parent 60c57b7
commit 1abdfa7
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/bottleneck/src/template/move/move_nanstd.py b/bottleneck/src/template/move/move_nanstd.py
@@ -215,6 +215,10 @@ def move_nanstd(arr, int window, int axis=-1, int ddof=0):
         The axis over which to perform the moving standard deviation. By
         default the moving standard deviation is taken over the last axis
         (axis=-1). An axis of None is not allowed.
+    ddof : int, optional
+        Means Delta Degrees of Freedom. The divisor used in calculations
+        is ``N - ddof``, where ``N`` represents the number of elements.
+        By default `ddof` is zero.
 
     Returns
     -------

diff --git a/bottleneck/src/template/move/move_std.py b/bottleneck/src/template/move/move_std.py
@@ -305,6 +305,10 @@ def move_std(arr, int window, int axis=-1, int ddof=0):
         The axis over which to perform the moving standard deviation. By
         default the moving standard deviation is taken over the last axis
         (axis=-1). An axis of None is not allowed.
+    ddof : int, optional
+        Means Delta Degrees of Freedom. The divisor used in calculations
+        is ``N - ddof``, where ``N`` represents the number of elements.
+        By default `ddof` is zero.
 
     Returns
     -------