Skip to content

Commit d36c589

Browse files
authored
docs: Fix ES01, SA01 code check of pandas.api.types.is_bool_dtype (#59507)
* docs: FIx ES01, SA01 code check of `pandas.api.types.is_bool_dtype` * chore: Remove pandas in See Also
1 parent eba59fa commit d36c589

File tree

2 files changed

+8
-1
lines changed

2 files changed

+8
-1
lines changed

ci/code_checks.sh

-1
Original file line numberDiff line numberDiff line change
@@ -239,7 +239,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
239239
-i "pandas.api.extensions.ExtensionArray.view SA01" \
240240
-i "pandas.api.interchange.from_dataframe RT03,SA01" \
241241
-i "pandas.api.types.is_bool PR01,SA01" \
242-
-i "pandas.api.types.is_bool_dtype SA01" \
243242
-i "pandas.api.types.is_categorical_dtype SA01" \
244243
-i "pandas.api.types.is_complex PR01,SA01" \
245244
-i "pandas.api.types.is_complex_dtype SA01" \

pandas/core/dtypes/common.py

+8
Original file line numberDiff line numberDiff line change
@@ -1274,6 +1274,10 @@ def is_bool_dtype(arr_or_dtype) -> bool:
12741274
"""
12751275
Check whether the provided array or dtype is of a boolean dtype.
12761276
1277+
This function verifies whether a given object is a boolean data type. The input
1278+
can be an array or a dtype object. Accepted array types include instances
1279+
of ``np.array``, ``pd.Series``, ``pd.Index``, and similar array-like structures.
1280+
12771281
Parameters
12781282
----------
12791283
arr_or_dtype : array-like or dtype
@@ -1284,6 +1288,10 @@ def is_bool_dtype(arr_or_dtype) -> bool:
12841288
boolean
12851289
Whether or not the array or dtype is of a boolean dtype.
12861290
1291+
See Also
1292+
--------
1293+
api.types.is_bool : Check if an object is a boolean.
1294+
12871295
Notes
12881296
-----
12891297
An ExtensionArray is considered boolean when the ``_is_boolean``

0 commit comments

Comments
 (0)