Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion ci/code_checks.sh
Original file line number Diff line number Diff line change
Expand Up @@ -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" \
Expand Down
9 changes: 9 additions & 0 deletions pandas/core/dtypes/common.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading