Skip to content

DOC: Remove incorrect elements of PeriodIndex docstring #16553

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 2 commits into from
Jun 1, 2017
Merged

DOC: Remove incorrect elements of PeriodIndex docstring #16553

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1e78866
DOC: Remove incorrect elements of PeriodIndex docstring
tui-rob May 31, 2017
51c329b
Removed trailing space
TomAugspurger Jun 1, 2017
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
10 changes: 1 addition & 9 deletions pandas/core/indexes/period.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,15 +125,7 @@ def _new_PeriodIndex(cls, **d):
class PeriodIndex(DatelikeOps, DatetimeIndexOpsMixin, Int64Index):
"""
Immutable ndarray holding ordinal values indicating regular periods in
time such as particular years, quarters, months, etc. A value of 1 is the
period containing the Gregorian proleptic datetime Jan 1, 0001 00:00:00.
This ordinal representation is from the scikits.timeseries project.

For instance,
# construct period for day 1/1/1 and get the first second
i = Period(year=1,month=1,day=1,freq='D').asfreq('S', 'S')
i.ordinal
===> 1
time such as particular years, quarters, months, etc.

Index keys are boxed to Period objects which carries the metadata (eg,
frequency information).
Expand Down