DOC: Clarify __array__ protocol arguments
#28226
Merged
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
I was told the current docs are a bit unclear, so trying to make them more clear. Also, we always were OK with `dtype=` being ignored, there seems little point in denying that when even `pandas` does it. Not sure I quite like the phrasing around "least desirable", but didn't have a better idea (since yes, one should look at all options).
ngoldbaum
reviewed
Jan 24, 2025
| - ``dtype`` is the requested data type of the returned array and is passed | ||
| by NumPy positionally (only if requested by the user). | ||
| It is acceptable to ignore the ``dtype`` because NumPy will check the | ||
| result and cast to ``dtype`` if necessary. |
There was a problem hiding this comment.
Maybe add "If it is more efficient to coerce the data to the requested dtype without relying on NumPy, you should handle it in your library.", to give people a hint towards the more performant thing.
There was a problem hiding this comment.
Yeah, was a bit unsure if pointing out the performance impact is worthwhile, but if you lean that way, let me add that sentence.
We raise a |
|
Thanks @seberg |
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.
I was told the current docs are a bit unclear, so trying to make them more clear.
Also, we always were OK with
dtype=being ignored, there seems little point in denying that when evenpandasdoes it.Not sure I quite like the phrasing around "least desirable", but didn't have a better idea (since yes, one should look at all options).