Skip to content

DOC: Add SA01 for pandas.api.types.is_timedelta64_ns_dtype, pandas.api.types.is_period_dtype and pandas.api.types.is_numeric_dtype #59446

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
Aug 8, 2024
Merged

DOC: Add SA01 for pandas.api.types.is_timedelta64_ns_dtype, pandas.api.types.is_period_dtype and pandas.api.types.is_numeric_dtype #59446

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
3 changes: 0 additions & 3 deletions ci/code_checks.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -284,12 +284,9 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.api.types.is_iterator PR07,SA01" \
-i "pandas.api.types.is_list_like SA01" \
-i "pandas.api.types.is_named_tuple PR07,SA01" \
-i "pandas.api.types.is_numeric_dtype SA01" \
-i "pandas.api.types.is_object_dtype SA01" \
-i "pandas.api.types.is_period_dtype SA01" \
-i "pandas.api.types.is_re PR07,SA01" \
-i "pandas.api.types.is_re_compilable PR07,SA01" \
-i "pandas.api.types.is_timedelta64_ns_dtype SA01" \
-i "pandas.api.types.pandas_dtype PR07,RT03,SA01" \
-i "pandas.arrays.ArrowExtensionArray PR07,SA01" \
-i "pandas.arrays.BooleanArray SA01" \
Expand Down
21 changes: 21 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 @@ -412,6 +412,13 @@ def is_period_dtype(arr_or_dtype) -> bool:
boolean
Whether or not the array-like or dtype is of the Period 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_timedelta64_dtype: Check whether an array-like or dtype
is of the timedelta64 dtype.

Examples
--------
>>> from pandas.core.dtypes.common import is_period_dtype
Expand Down Expand Up @@ -1021,6 +1028,11 @@ def is_timedelta64_ns_dtype(arr_or_dtype) -> bool:
boolean
Whether or not the array or dtype is of the timedelta64[ns] dtype.

See Also
--------
api.types.is_timedelta64_dtype: Check whether an array-like or dtype
is of the timedelta64 dtype.

Examples
--------
>>> from pandas.core.dtypes.common import is_timedelta64_ns_dtype
Expand Down Expand Up @@ -1140,6 +1152,15 @@ def is_numeric_dtype(arr_or_dtype) -> bool:
boolean
Whether or not the array or dtype is of a numeric dtype.

See Also
--------
api.types.is_integer_dtype: Check whether the provided array or dtype
is of an integer dtype.
api.types.is_unsigned_integer_dtype: Check whether the provided array
or dtype is of an unsigned integer dtype.
api.types.is_signed_integer_dtype: Check whether the provided array
or dtype is of an signed integer dtype.

Examples
--------
>>> from pandas.api.types import is_numeric_dtype
Expand Down