Skip to content

DOC: fix SA01 for pandas.api.types.is_integer_dtype #59803

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
Sep 15, 2024
Merged

DOC: fix SA01 for pandas.api.types.is_integer_dtype #59803

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 @@ -121,7 +121,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.api.types.is_hashable PR01,RT03,SA01" \
-i "pandas.api.types.is_int64_dtype SA01" \
-i "pandas.api.types.is_integer PR01,SA01" \
-i "pandas.api.types.is_integer_dtype SA01" \
-i "pandas.api.types.is_interval_dtype SA01" \
-i "pandas.api.types.is_iterator PR07,SA01" \
-i "pandas.api.types.is_list_like SA01" \
Expand Down
9 changes: 9 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 @@ -694,6 +694,15 @@ def is_integer_dtype(arr_or_dtype) -> bool:
Whether or not the array or dtype is of an integer dtype and
not an instance of timedelta64.

See Also
--------
api.types.is_integer : Return True if given object is integer.
api.types.is_numeric_dtype : Check whether the provided array or dtype is of a
numeric dtype.
api.types.is_float_dtype : Check whether the provided array or dtype is of a
float dtype.
Int64Dtype : An ExtensionDtype for Int64Dtype integer data.

Examples
--------
>>> from pandas.api.types import is_integer_dtype
Expand Down
Loading