DOC: clarify that check_array_indexer accepts int and slice #62573
+12
−4
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Updated parameter documentation to explicitly mention int, slice, and other non-array indexers are accepted - Added examples showing int and slice usage - Fixes pandas-dev#62562
mroeschke
approved these changes
Oct 5, 2025
|
Thanks @sah0725 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #62562
Summary
Updated the documentation for
pandas.api.indexers.check_array_indexerto clarify that it accepts integer and slice indexers in addition to array-like inputs.Changes Made
int,slice, and other non-array indexers are acceptedintandsliceusage in the docstringIssue Reference
The function already accepted these input types but the documentation only mentioned "array-like or list-like", which was misleading. This PR makes the documentation consistent with the actual behavior.