Skip to content

Commit 3c78b2f

Browse files
ihsansecerjreback
authored andcommitted
DOC: Clarify column type for 'on' parameter of rolling (pandas-dev#27265)
1 parent fd2146f commit 3c78b2f

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

pandas/core/window.py

+4-2
Original file line numberDiff line numberDiff line change
@@ -513,8 +513,10 @@ class Window(_Window):
513513
Provide a window type. If ``None``, all points are evenly weighted.
514514
See the notes below for further information.
515515
on : str, optional
516-
For a DataFrame, column on which to calculate
517-
the rolling window, rather than the index.
516+
For a DataFrame, a datetime-like column on which to calculate the rolling
517+
window, rather than the DataFrame's index. Provided integer column is
518+
ignored and excluded from result since an integer index is not used to
519+
calculate the rolling window.
518520
axis : int or str, default 0
519521
closed : str, default None
520522
Make the interval closed on the 'right', 'left', 'both' or

0 commit comments

Comments
 (0)