Skip to content

Commit

Permalink
DOC: Enforce Numpy Docstring Validation for pandas.DatetimeIndex.to_p…
Browse files Browse the repository at this point in the history
…eriod (#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
  • Loading branch information
tuhinsharma121 committed Apr 29, 2024
1 parent 2a7ad2e commit 6af69a0
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
3 changes: 1 addition & 2 deletions ci/code_checks.sh
Expand Up @@ -100,7 +100,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.DataFrame.var PR01,RT03,SA01" \
-i "pandas.DatetimeIndex.indexer_at_time PR01,RT03" \
-i "pandas.DatetimeIndex.snap PR01,RT03" \
-i "pandas.DatetimeIndex.to_period RT03" \
-i "pandas.Grouper PR02" \
-i "pandas.Index PR07" \
-i "pandas.Index.append PR07,RT03,SA01" \
Expand Down Expand Up @@ -242,7 +241,7 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.Series.dt.round PR01,PR02" \
-i "pandas.Series.dt.seconds SA01" \
-i "pandas.Series.dt.strftime PR01,PR02" \
-i "pandas.Series.dt.to_period PR01,PR02,RT03" \
-i "pandas.Series.dt.to_period PR01,PR02" \
-i "pandas.Series.dt.total_seconds PR01" \
-i "pandas.Series.dt.tz_convert PR01,PR02" \
-i "pandas.Series.dt.tz_localize PR01,PR02" \
Expand Down
1 change: 1 addition & 0 deletions pandas/core/arrays/datetimes.py
Expand Up @@ -1207,6 +1207,7 @@ def to_period(self, freq=None) -> PeriodArray:
Returns
-------
PeriodArray/PeriodIndex
Immutable ndarray holding ordinal values at a particular frequency.
Raises
------
Expand Down

0 comments on commit 6af69a0

Please sign in to comment.