Skip to content

DOC: Update the Period.day docstring #20294

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
Mar 12, 2018
Merged

DOC: Update the Period.day docstring #20294

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2e940f0
Add docstring for period.day
IHackPy Mar 12, 2018
85633a9
Update changes
IHackPy Mar 12, 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
19 changes: 19 additions & 0 deletions pandas/_libs/tslibs/period.pyx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1217,6 +1217,25 @@ cdef class _Period(object):

@property
def day(self):
"""
Get day of the month that a Period falls on.

Returns
-------
int

See Also
--------
Period.dayofweek : Get the day of the week

Period.dayofyear : Get the day of the year

Examples
--------
>>> p = pd.Period("2018-03-11", freq='H')
>>> p.day
11
"""
base, mult = get_freq_code(self.freq)
return pday(self.ordinal, base)

Expand Down