DOC: Clarify that is_scalar treats Enum members as scalars #62132
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 docstring to explain exclusion rule clearly - Added Enum example to documentation The docstring now clearly states that anything except list, tuple, numpy.ndarray, and pandas Series is treated as scalar, including Enum members. Fixes pandas-dev#62063
|
pre-commit.ci autofix |
|
This looks like AI. Please don’t do that. |
|
@jbrockmendel May I please know which section you are referring to . |
|
Agreed, closing as it appears this is AI generated |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Description
This PR updates the
is_scalardocstring to clarify that Enum members are treated as scalars, addressing the confusion reported in #62063.The
is_scalarfunction already correctly treats Enum members as scalars (viaisinstance(val, Enum)in the implementation), but the documentation was unclear about this behavior, leading to confusion for users and type checkers.Changes Made
list,tuple,numpy.ndarray, andpandas Seriesare considered non-scalarChecklist