DOC: specify range for step

This commit is contained in:
François Boulogne
2014-03-15 07:42:08 -04:00
parent cf7a184ba7
commit ced3f5656f
+3 -2
View File
@@ -111,9 +111,10 @@ def view_as_windows(arr_in, window_shape, step=1):
window_shape: tuple
Defines the shape of the elementary n-dimensional orthotope
(better know as hyperrectangle [1]_) of the rolling window view.
step : int
step : int, optional
Number of elements to skip when moving the window forward (by
default, move forward by one).
default, move forward by one). The value must be equal or larger
than one.
Returns
-------