Skip to content

Commit 435babd

Browse files
committed
DOC: Expand on usage.
1 parent 6318cc0 commit 435babd

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

pandas/core/generic.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3159,12 +3159,14 @@ def shift(self, periods=1, freq=None, axis=0, **kwds):
31593159
periods : int
31603160
Number of periods to move, can be positive or negative
31613161
freq : DateOffset, timedelta, or time rule string, optional
3162-
Increment to use from datetools module or time rule (e.g. 'EOM')
3162+
Increment to use from datetools module or time rule (e.g. 'EOM').
3163+
See Notes.
31633164
31643165
Notes
31653166
-----
31663167
If freq is specified then the index values are shifted but the data
3167-
if not realigned
3168+
is not realigned. That is, use freq if you would like to extend the
3169+
index when shifting and preserve the original data.
31683170
31693171
Returns
31703172
-------

0 commit comments

Comments
 (0)