Skip to content
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

Jump to bottom

DOC: update the Index.shift docstring #20192

Merged
merged 3 commits into from
Mar 10, 2018
Merged

DOC: update the Index.shift docstring #20192

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a520a93
DOC: updating docstring of Index.shift
Mar 10, 2018
cafcf63
Add See Also section to shift
Mar 10, 2018
003cd14
Update link to Series.shift
Mar 10, 2018
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
15 changes: 10 additions & 5 deletions pandas/core/indexes/base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2256,18 +2256,19 @@ def sortlevel(self, level=None, ascending=True, sort_remaining=None):
return self.sort_values(return_indexer=True, ascending=ascending)

def shift(self, periods=1, freq=None):
"""Shift index by desired number of time frequency increments.
"""
Shift index by desired number of time frequency increments.

This method is for shifting the values of datetime-like indexes
by a specified time increment a given number of times.

Parameters
----------
periods : int
periods : int, default 1
Number of periods (or increments) to shift by,
can be positive or negative (default is 1).
freq : pandas.DateOffset, pandas.Timedelta or string
Frequency increment to shift by (default is None).
can be positive or negative.
freq : pandas.DateOffset, pandas.Timedelta or string, optional
Frequency increment to shift by.
If None, the index is shifted by its own `freq` attribute.
Offset aliases are valid strings, e.g., 'D', 'W', 'M' etc.

Expand All @@ -2276,6 +2277,10 @@ def shift(self, periods=1, freq=None):
pandas.Index
shifted index

See Also
--------
Series.shift : Shift values of Series.

Examples
--------
Put the first 5 month starts of 2011 into an index.
Expand Down