Skip to content

Commit 7c836ed

Browse files
DOC: Enforce Numpy Docstring Validation for pandas.DatetimeIndex.freqstr (#58309)
* DOC: add SA01 to pandas.DatetimeIndex.freqstr * DOC: remove pandas.DatetimeIndex.freqstr * DOC: removed pandas.PeriodIndex.freqstr
1 parent 39363cf commit 7c836ed

File tree

2 files changed

+5
-2
lines changed

2 files changed

+5
-2
lines changed

ci/code_checks.sh

-2
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
9898
-i "pandas.DataFrame.swaplevel SA01" \
9999
-i "pandas.DataFrame.to_markdown SA01" \
100100
-i "pandas.DataFrame.var PR01,RT03,SA01" \
101-
-i "pandas.DatetimeIndex.freqstr SA01" \
102101
-i "pandas.DatetimeIndex.indexer_at_time PR01,RT03" \
103102
-i "pandas.DatetimeIndex.snap PR01,RT03" \
104103
-i "pandas.DatetimeIndex.std PR01,RT03" \
@@ -203,7 +202,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
203202
-i "pandas.PeriodIndex.dayofyear SA01" \
204203
-i "pandas.PeriodIndex.days_in_month SA01" \
205204
-i "pandas.PeriodIndex.daysinmonth SA01" \
206-
-i "pandas.PeriodIndex.freqstr SA01" \
207205
-i "pandas.PeriodIndex.from_fields PR07,SA01" \
208206
-i "pandas.PeriodIndex.from_ordinals SA01" \
209207
-i "pandas.PeriodIndex.hour SA01" \

pandas/core/arrays/datetimelike.py

+5
Original file line numberDiff line numberDiff line change
@@ -875,6 +875,11 @@ def freqstr(self) -> str | None:
875875
"""
876876
Return the frequency object as a string if it's set, otherwise None.
877877
878+
See Also
879+
--------
880+
DatetimeIndex.inferred_freq : Returns a string representing a frequency
881+
generated by infer_freq.
882+
878883
Examples
879884
--------
880885
For DatetimeIndex:

0 commit comments

Comments
 (0)