Skip to content

Commit 6af69a0

Browse files
DOC: Enforce Numpy Docstring Validation for pandas.DatetimeIndex.to_period (#58440)
* DOC: add RT03 for pandas.DatetimeIndex.to_period * DOC: remove RT03 for pandas.DatetimeIndex.to_period * DOC: remove RT03 for pandas.Series.dt.to_period
1 parent 2a7ad2e commit 6af69a0

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

ci/code_checks.sh

+1-2
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
100100
-i "pandas.DataFrame.var PR01,RT03,SA01" \
101101
-i "pandas.DatetimeIndex.indexer_at_time PR01,RT03" \
102102
-i "pandas.DatetimeIndex.snap PR01,RT03" \
103-
-i "pandas.DatetimeIndex.to_period RT03" \
104103
-i "pandas.Grouper PR02" \
105104
-i "pandas.Index PR07" \
106105
-i "pandas.Index.append PR07,RT03,SA01" \
@@ -242,7 +241,7 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
242241
-i "pandas.Series.dt.round PR01,PR02" \
243242
-i "pandas.Series.dt.seconds SA01" \
244243
-i "pandas.Series.dt.strftime PR01,PR02" \
245-
-i "pandas.Series.dt.to_period PR01,PR02,RT03" \
244+
-i "pandas.Series.dt.to_period PR01,PR02" \
246245
-i "pandas.Series.dt.total_seconds PR01" \
247246
-i "pandas.Series.dt.tz_convert PR01,PR02" \
248247
-i "pandas.Series.dt.tz_localize PR01,PR02" \

pandas/core/arrays/datetimes.py

+1
Original file line numberDiff line numberDiff line change
@@ -1207,6 +1207,7 @@ def to_period(self, freq=None) -> PeriodArray:
12071207
Returns
12081208
-------
12091209
PeriodArray/PeriodIndex
1210+
Immutable ndarray holding ordinal values at a particular frequency.
12101211
12111212
Raises
12121213
------

0 commit comments

Comments
 (0)