Skip to content
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.

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

DOC: fix see also in docstring of check_bool_array_indexer #30725

Merged
Merged
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions pandas/core/indexers.py
Original file line number Diff line number Diff line change
Expand Up @@ -274,14 +274,14 @@ def check_bool_array_indexer(array: AnyArrayLike, mask: AnyArrayLike) -> np.ndar

See Also
--------
api.extensions.is_bool_indexer : Check if `key` is a boolean indexer.
api.types.is_bool_dtype : Check if `key` is of boolean dtype.

Examples
--------
A boolean ndarray is returned when the arguments are all valid.

>>> mask = pd.array([True, False])
>>> arr = pd.Series([1, 2])
>>> arr = pd.array([1, 2])
>>> pd.api.extensions.check_bool_array_indexer(arr, mask)
array([ True, False])

Expand Down