Skip to content

DOC: Expand on freq in shift usage. #6489

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
merged 1 commit into from
Feb 26, 2014
Merged

DOC: Expand on freq in shift usage. #6489

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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/generic.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3159,12 +3159,14 @@ def shift(self, periods=1, freq=None, axis=0, **kwds):
periods : int
Number of periods to move, can be positive or negative
freq : DateOffset, timedelta, or time rule string, optional
Increment to use from datetools module or time rule (e.g. 'EOM')
Increment to use from datetools module or time rule (e.g. 'EOM').
See Notes.

Notes
-----
If freq is specified then the index values are shifted but the data
if not realigned
is not realigned. That is, use freq if you would like to extend the
index when shifting and preserve the original data.

Returns
-------
Expand Down