Skip to content

Commit 72ab3fd

Browse files
authored
DOC: fix docstring validation errors for pandas.Series.dt.freq (#60377)
* Added docs for Series.dt.freq and removed from ci/code_checks.sh * Fix code style
1 parent 24df015 commit 72ab3fd

File tree

2 files changed

+22
-1
lines changed

2 files changed

+22
-1
lines changed

ci/code_checks.sh

-1
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
7373
-i "pandas.Period.freq GL08" \
7474
-i "pandas.Period.ordinal GL08" \
7575
-i "pandas.RangeIndex.from_range PR01,SA01" \
76-
-i "pandas.Series.dt.freq GL08" \
7776
-i "pandas.Series.dt.unit GL08" \
7877
-i "pandas.Series.pad PR01,SA01" \
7978
-i "pandas.Timedelta.max PR02" \

pandas/core/indexes/accessors.py

+22
Original file line numberDiff line numberDiff line change
@@ -373,6 +373,28 @@ def to_pydatetime(self) -> Series:
373373

374374
@property
375375
def freq(self):
376+
"""
377+
Tries to return a string representing a frequency generated by infer_freq.
378+
379+
Returns None if it can't autodetect the frequency.
380+
381+
See Also
382+
--------
383+
Series.dt.to_period : Cast to PeriodArray/PeriodIndex at a particular
384+
frequency.
385+
386+
Examples
387+
--------
388+
>>> ser = pd.Series(["2024-01-01", "2024-01-02", "2024-01-03", "2024-01-04"])
389+
>>> ser = pd.to_datetime(ser)
390+
>>> ser.dt.freq
391+
'D'
392+
393+
>>> ser = pd.Series(["2022-01-01", "2024-01-01", "2026-01-01", "2028-01-01"])
394+
>>> ser = pd.to_datetime(ser)
395+
>>> ser.dt.freq
396+
'2YS-JAN'
397+
"""
376398
return self._get_values().inferred_freq
377399

378400
def isocalendar(self) -> DataFrame:

0 commit comments

Comments
 (0)