Skip to content

Commit f152a25

Browse files
authored
DOC: point out that only period aliases are valid for the method asfreq in period.pyx (#53751)
DOC: point out that only period aliases are valid for Period method asfreq
1 parent d36da2b commit f152a25

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

pandas/_libs/tslibs/period.pyx

+2-1
Original file line numberDiff line numberDiff line change
@@ -1917,7 +1917,8 @@ cdef class _Period(PeriodMixin):
19171917
Parameters
19181918
----------
19191919
freq : str, BaseOffset
1920-
The desired frequency.
1920+
The desired frequency. If passing a `str`, it needs to be a
1921+
valid :ref:`period alias <timeseries.period_aliases>`.
19211922
how : {'E', 'S', 'end', 'start'}, default 'end'
19221923
Start or end of the timespan.
19231924

0 commit comments

Comments
 (0)