DOC: Enforce Numpy Docstring Validation for pandas.DatetimeIndex.tzco…

…nvert (#58416) * DOC: remove pandas.DatetimeIndex.tz_convert * DOC: add RT03 to pandas.DatetimeIndex.tz_convert * DOC: removed RT03 from pandas.Series.dt.tz_convert
pandas-dev · Apr 25, 2024 · a0977f5 · a0977f5
1 parent 8a9325f
commit a0977f5
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/ci/code_checks.sh b/ci/code_checks.sh
@@ -109,7 +109,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
         -i "pandas.DatetimeIndex.std PR01,RT03" \
         -i "pandas.DatetimeIndex.to_period RT03" \
         -i "pandas.DatetimeIndex.to_pydatetime RT03,SA01" \
-        -i "pandas.DatetimeIndex.tz_convert RT03" \
         -i "pandas.DatetimeTZDtype SA01" \
         -i "pandas.DatetimeTZDtype.tz SA01" \
         -i "pandas.Grouper PR02" \
@@ -272,7 +271,7 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
         -i "pandas.Series.dt.strftime PR01,PR02" \
         -i "pandas.Series.dt.to_period PR01,PR02,RT03" \
         -i "pandas.Series.dt.total_seconds PR01" \
-        -i "pandas.Series.dt.tz_convert PR01,PR02,RT03" \
+        -i "pandas.Series.dt.tz_convert PR01,PR02" \
         -i "pandas.Series.dt.tz_localize PR01,PR02" \
         -i "pandas.Series.dt.unit GL08" \
         -i "pandas.Series.dtype SA01" \

diff --git a/pandas/core/arrays/datetimes.py b/pandas/core/arrays/datetimes.py
@@ -867,6 +867,7 @@ def tz_convert(self, tz) -> Self:
         Returns
         -------
         Array or Index
+            Datetme Array/Index with target `tz`.
 
         Raises
         ------
-Original file line number
+Diff line change
@@ Expand Up / @@ -867,6 +867,7 @@ def tz_convert(self, tz) -> Self: @@
             Returns
             -------
             Array or Index
+                Datetme Array/Index with target `tz`.
             Raises
             ------
@@ Expand Down @@