From 9f4c073f0cbbef69dac790fff92984cbc932b8e2 Mon Sep 17 00:00:00 2001 From: Tuhin Sharma Date: Sun, 15 Sep 2024 11:12:11 +0530 Subject: [PATCH] DOC: fix SA01 for pandas.api.types.is_integer_dtype --- ci/code_checks.sh | 1 - pandas/core/dtypes/common.py | 9 +++++++++ 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/ci/code_checks.sh b/ci/code_checks.sh index 73b389e427648..e099f76204906 100755 --- a/ci/code_checks.sh +++ b/ci/code_checks.sh @@ -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" \ diff --git a/pandas/core/dtypes/common.py b/pandas/core/dtypes/common.py index 16f6bd396fe93..53edb7ced8f43 100644 --- a/pandas/core/dtypes/common.py +++ b/pandas/core/dtypes/common.py @@ -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