DOC: add SA01 for pandas.api.types.is_datetime64_any_dtype

pandas-dev · May 19, 2024 · 4c95dd5 · 4c95dd5
1 parent 593113a
commit 4c95dd5
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 1 deletion.
diff --git a/ci/code_checks.sh b/ci/code_checks.sh
@@ -317,7 +317,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
         -i "pandas.api.types.is_categorical_dtype SA01" \
         -i "pandas.api.types.is_complex PR01,SA01" \
         -i "pandas.api.types.is_complex_dtype SA01" \
-        -i "pandas.api.types.is_datetime64_any_dtype SA01" \
         -i "pandas.api.types.is_datetime64_dtype SA01" \
         -i "pandas.api.types.is_datetime64_ns_dtype SA01" \
         -i "pandas.api.types.is_datetime64tz_dtype SA01" \

diff --git a/pandas/core/dtypes/common.py b/pandas/core/dtypes/common.py
@@ -873,6 +873,15 @@ def is_datetime64_any_dtype(arr_or_dtype) -> bool:
     bool
         Whether or not the array or dtype is of the datetime64 dtype.
 
+    See Also
+    --------
+    api.types.is_datetime64_dtype : Check whether an array-like or dtype is of the
+        datetime64 dtype.
+    api.is_datetime64_ns_dtype : Check whether the provided array or dtype is of the
+        datetime64[ns] dtype.
+    api.is_datetime64tz_dtype : Check whether an array-like or dtype is of a
+        DatetimeTZDtype dtype.
+
     Examples
     --------
     >>> from pandas.api.types import is_datetime64_any_dtype