Skip to content

Commit 75dfa21

Browse files
IHackPyjorisvandenbossche
authored andcommitted
DOC: Update the Period.day docstring (#20294)
1 parent df2e361 commit 75dfa21

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

pandas/_libs/tslibs/period.pyx

+19
Original file line numberDiff line numberDiff line change
@@ -1217,6 +1217,25 @@ cdef class _Period(object):
12171217

12181218
@property
12191219
def day(self):
1220+
"""
1221+
Get day of the month that a Period falls on.
1222+
1223+
Returns
1224+
-------
1225+
int
1226+
1227+
See Also
1228+
--------
1229+
Period.dayofweek : Get the day of the week
1230+
1231+
Period.dayofyear : Get the day of the year
1232+
1233+
Examples
1234+
--------
1235+
>>> p = pd.Period("2018-03-11", freq='H')
1236+
>>> p.day
1237+
11
1238+
"""
12201239
base, mult = get_freq_code(self.freq)
12211240
return pday(self.ordinal, base)
12221241

0 commit comments

Comments
 (0)