DOC: Enforce Numpy Docstring Validation for pandas.DatetimeTZDtype.un…

…it (#58387) * DOC: add SA01 to DatetimeTZDtype.tz * DOC: remove SA01 of DatetimeTZDtype.unit
pandas-dev · Apr 23, 2024 · 8aa4f0e · 8aa4f0e
1 parent 9d5c88e
commit 8aa4f0e
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/ci/code_checks.sh b/ci/code_checks.sh
@@ -116,7 +116,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
         -i "pandas.DatetimeIndex.tz_convert RT03" \
         -i "pandas.DatetimeTZDtype SA01" \
         -i "pandas.DatetimeTZDtype.tz SA01" \
-        -i "pandas.DatetimeTZDtype.unit SA01" \
         -i "pandas.Grouper PR02" \
         -i "pandas.Index PR07" \
         -i "pandas.Index.T SA01" \

diff --git a/pandas/core/dtypes/dtypes.py b/pandas/core/dtypes/dtypes.py
@@ -793,6 +793,10 @@ def unit(self) -> str_type:
         """
         The precision of the datetime data.
 
+        See Also
+        --------
+        DatetimeTZDtype.tz : Retrieves the timezone.
+
         Examples
         --------
         >>> from zoneinfo import ZoneInfo