Skip to content

DOC: add SA01 for pandas.api.types.is_timedelta64_dtype #58787

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.

Sign up for GitHub

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
merged 1 commit into from
May 19, 2024
+7 −1
Merged

DOC: add SA01 for pandas.api.types.is_timedelta64_dtype #58787

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -342,7 +342,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.api.types.is_signed_integer_dtype SA01" \
-i "pandas.api.types.is_sparse SA01" \
-i "pandas.api.types.is_string_dtype SA01" \
-i "pandas.api.types.is_timedelta64_dtype SA01" \
-i "pandas.api.types.is_timedelta64_ns_dtype SA01" \
-i "pandas.api.types.is_unsigned_integer_dtype SA01" \
-i "pandas.api.types.pandas_dtype PR07,RT03,SA01" \
Expand Down
7 changes: 7 additions & 0 deletions pandas/core/dtypes/common.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -362,6 +362,13 @@ def is_timedelta64_dtype(arr_or_dtype) -> bool:
boolean
Whether or not the array-like or dtype is of the timedelta64 dtype.

See Also
--------
api.types.is_timedelta64_ns_dtype : Check whether the provided array or dtype is
of the timedelta64[ns] dtype.
api.types.is_period_dtype : Check whether an array-like or dtype is of the
Period dtype.

Examples
--------
>>> from pandas.core.dtypes.common import is_timedelta64_dtype
Expand Down
Loading