Skip to content

DOC: docstring, closes #23475 #34619

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 1 commit into from
Jun 7, 2020
Merged

DOC: docstring, closes #23475 #34619

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 10 additions & 1 deletion pandas/_libs/tslibs/period.pyx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1529,7 +1529,16 @@ cdef class _Period:
self._dtype = PeriodPseudoDtype(freq._period_dtype_code)

@classmethod
def _maybe_convert_freq(cls, object freq):
def _maybe_convert_freq(cls, object freq) -> BaseOffset:
"""
Internally we allow integer and tuple representations (for now) that
are not recognized by to_offset, so we convert them here. Also, a
Period's freq attribute must have `freq.n > 0`, which we check for here.

Returns
-------
DateOffset
"""
if isinstance(freq, (int, tuple)):
code, stride = get_freq_code(freq)
freq = get_freq_str(code, stride)
Expand Down