Skip to content

DOC: update the Period.start_time attribute docstring #20325

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.

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
30 changes: 30 additions & 0 deletions pandas/_libs/tslibs/period.pyx
Original file line number Diff line number Diff line change
Expand Up @@ -1164,6 +1164,36 @@ cdef class _Period(object):

@property
def start_time(self):
"""
Return the Timestamp.
Copy link
Contributor

Choose a reason for hiding this comment

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

"Get the Timestamp for the start of the period."


This attribute returns the timestamp of the particular
Copy link
Contributor

Choose a reason for hiding this comment

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

This can be removed I think.

starting date for the given period.

See also
--------
Period.dayofyear
Copy link
Contributor

Choose a reason for hiding this comment

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

These can be one line each. Period.dayofyear : Return the day of year.

Return the day of year.
Period.daysinmonth
Return the days in that month.
Period.dayofweek
Return the day of the week.

Returns
Copy link
Contributor

Choose a reason for hiding this comment

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

Move returns above See Also

-------
Timestamp

Examples
--------
>>> period = pd.Period('2012-1-1', freq='D')
>>> period
Period('2012-01-01', 'D')

>>> period.start_time
Timestamp('2012-01-01 00:00:00')
>>> period.end_time
Timestamp('2012-01-01 23:59:59.999999999')
"""
return self.to_timestamp(how='S')

@property
Expand Down