From 1a10c2818fdc0460d36debad0d71df6a1f833b83 Mon Sep 17 00:00:00 2001 From: Natalia Mokeeva Date: Mon, 8 Jan 2024 23:42:02 +0100 Subject: [PATCH] add missing parameter is_period and examples to to_offsets --- pandas/_libs/tslibs/offsets.pyx | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/pandas/_libs/tslibs/offsets.pyx b/pandas/_libs/tslibs/offsets.pyx index b3788b6003e67..8ac59ea8cdde0 100644 --- a/pandas/_libs/tslibs/offsets.pyx +++ b/pandas/_libs/tslibs/offsets.pyx @@ -4734,6 +4734,10 @@ cpdef to_offset(freq, bint is_period=False): Parameters ---------- freq : str, datetime.timedelta, BaseOffset or None + The frequency represented. + is_period : bool, default False + Convert string denoting period frequency to corresponding offsets + frequency if is_period=True. Returns ------- @@ -4768,6 +4772,17 @@ cpdef to_offset(freq, bint is_period=False): >>> to_offset(pd.offsets.Hour()) + + Passing the parameter ``is_period`` equal to True, you can use a string + denoting period frequency: + + >>> freq = to_offset(freq="ME", is_period=False) + >>> freq.rule_code + 'ME' + + >>> freq = to_offset(freq="M", is_period=True) + >>> freq.rule_code + 'ME' """ if freq is None: return None