docs: clarify type promotion behavior in diff#881
Merged
kgryte merged 2 commits intodata-apis:mainfrom Jan 20, 2025
Merged
Conversation
Member
That seems like the right decision to me, and aligns with what was discussed in the community meeting yesterday. It's also the most flexible decision - in case a real-world use case for something more prescriptive regarding type promotion arises in the future, we can deal with it then. |
Contributor
Author
|
As this change is a relatively minor documentation change, was discussed and agreed upon during a prior workgroup meeting, and has not received any objections, I'll go ahead and merge. |
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
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.
This PR:
diffdoes not specify type promotion behavior #852prependandappendare of a different dtype thanx, behavior is left unspecified, thus allowing array libraries to opt for either type promotion, casting, or raising an exception.appendandprependhave the same data type asx.Notes
NumPy supports type promotion:
However, the NumPy docs state:
We have yet, TMK, allowed optional array kwargs to affect the output array dtype. It is not obvious to me that we should establish such a precedent here.