Skip to content

docs: Fix ES01, SA01 code check of pandas.api.types.is_bool_dtype #59507

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 2 commits into from
Aug 14, 2024
Merged

docs: Fix ES01, SA01 code check of pandas.api.types.is_bool_dtype #59507

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6ddc743
docs: FIx ES01, SA01 code check of `pandas.api.types.is_bool_dtype`
tan-i-ham Aug 14, 2024
2b0d6a9
chore: Remove pandas in See Also
tan-i-ham Aug 14, 2024
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 @@ -239,7 +239,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
-i "pandas.api.extensions.ExtensionArray.view SA01" \
-i "pandas.api.interchange.from_dataframe RT03,SA01" \
-i "pandas.api.types.is_bool PR01,SA01" \
-i "pandas.api.types.is_bool_dtype SA01" \
-i "pandas.api.types.is_categorical_dtype SA01" \
-i "pandas.api.types.is_complex PR01,SA01" \
-i "pandas.api.types.is_complex_dtype SA01" \
Expand Down
8 changes: 8 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 @@ -1274,6 +1274,10 @@ def is_bool_dtype(arr_or_dtype) -> bool:
"""
Check whether the provided array or dtype is of a boolean dtype.

This function verifies whether a given object is a boolean data type. The input
can be an array or a dtype object. Accepted array types include instances
of ``np.array``, ``pd.Series``, ``pd.Index``, and similar array-like structures.

Parameters
----------
arr_or_dtype : array-like or dtype
Expand All @@ -1284,6 +1288,10 @@ def is_bool_dtype(arr_or_dtype) -> bool:
boolean
Whether or not the array or dtype is of a boolean dtype.

See Also
--------
api.types.is_bool : Check if an object is a boolean.

Notes
-----
An ExtensionArray is considered boolean when the ``_is_boolean``
Expand Down