From 435babd9499ddd35a8472b2b17e707e35779ec5c Mon Sep 17 00:00:00 2001 From: Skipper Seabold Date: Wed, 26 Feb 2014 16:36:52 -0500 Subject: [PATCH] DOC: Expand on usage. --- pandas/core/generic.py | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/pandas/core/generic.py b/pandas/core/generic.py index 1879f77c7628b..811604432a018 100644 --- a/pandas/core/generic.py +++ b/pandas/core/generic.py @@ -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 -------