Skip to content

Commit e6c2647

Browse files
hammadmashkoorTomAugspurger
authored andcommitted
DOC: update the Period.start_time attribute docstring (#20325)
1 parent e1fb30b commit e6c2647

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

pandas/_libs/tslibs/period.pyx

+26
Original file line numberDiff line numberDiff line change
@@ -1164,6 +1164,32 @@ cdef class _Period(object):
11641164

11651165
@property
11661166
def start_time(self):
1167+
"""
1168+
Get the Timestamp for the start of the period.
1169+
1170+
Returns
1171+
-------
1172+
Timestamp
1173+
1174+
See also
1175+
--------
1176+
Period.end_time : Return the end Timestamp.
1177+
Period.dayofyear : Return the day of year.
1178+
Period.daysinmonth : Return the days in that month.
1179+
Period.dayofweek : Return the day of the week.
1180+
1181+
Examples
1182+
--------
1183+
>>> period = pd.Period('2012-1-1', freq='D')
1184+
>>> period
1185+
Period('2012-01-01', 'D')
1186+
1187+
>>> period.start_time
1188+
Timestamp('2012-01-01 00:00:00')
1189+
1190+
>>> period.end_time
1191+
Timestamp('2012-01-01 23:59:59.999999999')
1192+
"""
11671193
return self.to_timestamp(how='S')
11681194

11691195
@property

0 commit comments

Comments
 (0)