Skip to content

Commit c437139

Browse files
DOC: Add SA01 for pandas.api.types.is_signed_integer_dtype (#59246)
* adding See Also section for is_signed_integer_dtype * remove from code_check * Remove pandas and additional line break --------- Co-authored-by: Abhinav Thimma <[email protected]>
1 parent 3f82ed3 commit c437139

File tree

2 files changed

+9
-1
lines changed

2 files changed

+9
-1
lines changed

ci/code_checks.sh

-1
Original file line numberDiff line numberDiff line change
@@ -310,7 +310,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
310310
-i "pandas.api.types.is_period_dtype SA01" \
311311
-i "pandas.api.types.is_re PR07,SA01" \
312312
-i "pandas.api.types.is_re_compilable PR07,SA01" \
313-
-i "pandas.api.types.is_signed_integer_dtype SA01" \
314313
-i "pandas.api.types.is_sparse SA01" \
315314
-i "pandas.api.types.is_string_dtype SA01" \
316315
-i "pandas.api.types.is_timedelta64_ns_dtype SA01" \

pandas/core/dtypes/common.py

+9
Original file line numberDiff line numberDiff line change
@@ -715,6 +715,15 @@ def is_signed_integer_dtype(arr_or_dtype) -> bool:
715715
Whether or not the array or dtype is of a signed integer dtype
716716
and not an instance of timedelta64.
717717
718+
See Also
719+
--------
720+
api.types.is_integer_dtype: Check whether the provided array or dtype
721+
is of an integer dtype.
722+
api.types.is_numeric_dtype: Check whether the provided array or dtype
723+
is of a numeric dtype.
724+
api.types.is_unsigned_integer_dtype: Check whether the provided array
725+
or dtype is of an unsigned integer dtype.
726+
718727
Examples
719728
--------
720729
>>> from pandas.core.dtypes.common import is_signed_integer_dtype

0 commit comments

Comments
 (0)