Skip to content

DOC: updating docstring of Index.shift #19996

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 3 commits into from
Mar 7, 2018
Merged

DOC: updating docstring of Index.shift #19996

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a83acff
DOC: updating docstring of Index.shift
Mar 5, 2018
1523ba8
Removing See Also section, adding Returns and Examples sections
Mar 6, 2018
ce8379f
Extending Examples section
Mar 6, 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
Prev Previous commit
Extending Examples section
  • Loading branch information
Arpad Fulop committed Mar 6, 2018
commit ce8379fc0ae84ecd810707c5aeeaa039da8858a9
12 changes: 9 additions & 3 deletions pandas/core/indexes/base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2233,17 +2233,23 @@ def shift(self, periods=1, freq=None):

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

>>> month_starts = pd.date_range('1/1/2011', periods=5, freq='MS')
>>> month_starts
DatetimeIndex(['2011-01-01', '2011-02-01', '2011-03-01', '2011-04-01',
'2011-05-01'],
dtype='datetime64[ns]', freq='MS')

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you show the output here? (so it is easier to compare the result of the shift with the original)

Shift by 10 days.
Shift the index by 10 days.

>>> month_starts.shift(10, freq='D')
DatetimeIndex(['2011-01-11', '2011-02-11', '2011-03-11', '2011-04-11',
'2011-05-11'],
dtype='datetime64[ns]', freq=None)

The default value of `freq` is the `freq` attribute of the index;
in this example it is 'MS' (month start).
The default value of `freq` is the `freq` attribute of the index,
which is 'MS' (month start) in this example.

>>> month_starts.shift(10)
DatetimeIndex(['2011-11-01', '2011-12-01', '2012-01-01', '2012-02-01',
Expand Down