DOC: Clarify is_scalar docstring to specify scalar vs non-scalar and add Enum example (GH#62063) #62143
Conversation
|
Hi @rhshadrach, as per your suggestion on the issue, I’ve applied the changes. Could you please take a look and let me know if this correctly states and enhances the doc for the issue? |
There was a problem hiding this comment.
Thanks for the PR! I think I wasn't clear in #62063 (comment), that comment is recommending to change Series.eq documentation.
pandas/_libs/lib.pyx
Outdated
| >>> pd.api.types.is_scalar(Thing.one) | ||
| True |
There was a problem hiding this comment.
This is incorrect - the result here is False.
There was a problem hiding this comment.
Thankyou , for correcting me . I will fix this
pandas/_libs/lib.pyx
Outdated
| @@ -175,6 +175,13 @@ def is_scalar(val: object) -> bool: | |||
| - DateOffset | |||
| - Fraction | |||
| - Number. | |||
| - Any other non-sequence objects (e.g. Enum members, custom objects) | |||
There was a problem hiding this comment.
This is incorrect, most non-sequence objects will return False here.
Aniketsy
force-pushed
the
doc/is_scalar-docstring-clarification-clean
branch
from
b6754ff to
50ef24a
Compare
|
I apologize for the inconvenience with this PR. I’ll update the changes and open a new PR for this. |
(GH#62063)
This PR updates the docstring for is_scalar to better reflect its actual behavior in pandas.
Clearly differentiates between values considered scalars and values treated as non-scalars.
Explicitly documents that the following are treated as non-scalars
np.ndarray, list , tuple , pandas.Series.
Please let me know if this fix needs any improvements . I’m open to feedback and happy to make changes based on suggestions.
Thankyou!