Skip to content

Commit 4ec98d8

Browse files
tui-robTomAugspurger
authored andcommitted
DOC: Remove incorrect elements of PeriodIndex docstring (#16553)
* DOC: Remove incorrect elements of PeriodIndex docstring See #9056. * Removed trailing space
1 parent a7760e3 commit 4ec98d8

File tree

1 file changed

+1
-9
lines changed

1 file changed

+1
-9
lines changed

pandas/core/indexes/period.py

+1-9
Original file line numberDiff line numberDiff line change
@@ -125,15 +125,7 @@ def _new_PeriodIndex(cls, **d):
125125
class PeriodIndex(DatelikeOps, DatetimeIndexOpsMixin, Int64Index):
126126
"""
127127
Immutable ndarray holding ordinal values indicating regular periods in
128-
time such as particular years, quarters, months, etc. A value of 1 is the
129-
period containing the Gregorian proleptic datetime Jan 1, 0001 00:00:00.
130-
This ordinal representation is from the scikits.timeseries project.
131-
132-
For instance,
133-
# construct period for day 1/1/1 and get the first second
134-
i = Period(year=1,month=1,day=1,freq='D').asfreq('S', 'S')
135-
i.ordinal
136-
===> 1
128+
time such as particular years, quarters, months, etc.
137129
138130
Index keys are boxed to Period objects which carries the metadata (eg,
139131
frequency information).

0 commit comments

Comments
 (0)