Skip to content

Commit c56b6ad

Browse files
fix pandas.Series.dt.freq
1 parent 59bb3f4 commit c56b6ad

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

pandas/core/indexes/accessors.py

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -373,6 +373,36 @@ def to_pydatetime(self) -> Series:
373373

374374
@property
375375
def freq(self):
376+
"""
377+
Return the frequency object if it is set, otherwise None.
378+
379+
To learn more about the frequency strings, please see
380+
:ref:`this link<timeseries.offset_aliases>`.
381+
382+
See Also
383+
--------
384+
DatetimeIndex.freq : Return the frequency object if it is set, otherwise None.
385+
PeriodIndex.freq : Return the frequency object if it is set, otherwise None.
386+
387+
Examples
388+
--------
389+
>>> datetimeindex = pd.Series(
390+
... [
391+
... "2022-02-22 02:22:22-06:00",
392+
... "2022-02-22 03:22:22-06:00",
393+
... "2022-02-22 04:22:22-06:00",
394+
... "2022-02-22 05:22:22-06:00",
395+
... "2022-02-22 06:22:22-06:00",
396+
... "2022-02-22 07:22:22-06:00",
397+
... "2022-02-22 08:22:22-06:00",
398+
... "2022-02-22 09:22:22-06:00",
399+
... "2022-02-22 10:22:22-06:00",
400+
... "2022-02-22 11:22:22-06:00",
401+
... ]
402+
... )
403+
>>> datetimeindex.freq
404+
<H>
405+
"""
376406
return self._get_values().inferred_freq
377407

378408
def isocalendar(self) -> DataFrame:

0 commit comments

Comments
 (0)