Skip to content

DOC: Clarify column type for 'on' parameter of rolling #27265

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jreback merged 3 commits into from
Jul 8, 2019
Merged

DOC: Clarify column type for 'on' parameter of rolling #27265

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5b92b7e
DOC: Clarify column type for 'on' parameter of rolling
ihsansecer Jul 6, 2019
becd37c
Explain what happens when an integer column is provided
ihsansecer Jul 8, 2019
45c3d15
Minor change
ihsansecer Jul 8, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions pandas/core/window.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -513,8 +513,10 @@ class Window(_Window):
Provide a window type. If ``None``, all points are evenly weighted.
See the notes below for further information.
on : str, optional
For a DataFrame, column on which to calculate
the rolling window, rather than the index.
For a DataFrame, a datetime-like column on which to calculate the rolling
window, rather than the DataFrame's index. Provided integer column is
ignored and excluded from result since an integer index is not used to
calculate the rolling window.
axis : int or str, default 0
closed : str, default None
Make the interval closed on the 'right', 'left', 'both' or
Expand Down