docs: diff does not specify type promotion behavior #852

Activity

1. kgryte

   added this to the v2024 milestone on Nov 25, 2024
2. kgryte

   added

   bugSomething isn't working.Something isn't working.

   topic: Type PromotionType promotion.Type promotion.

   on Nov 25, 2024
3. kgryte

   changed the title [-]diff() does not specify type promotion behavior[/-] [+]docs: `diff` does not specify type promotion behavior[/+] on Jan 9, 2025
4. kgryte commented on Jan 9, 2025

   

   kgryte

   on Jan 9, 2025

   Last edited by kgryte

   Contributor

   More actions

   In the current specification guidance, we state that prepend and append should have the same data type as x. Given that prepend and append are kwarg-only and we have yet, TMK, to specify an API in which array kwargs may affect the output dtype, personally, I do not think we should allow type promotion such that the output array may be of a different dtype than x.

   However, I think we can clarify, in a note, that if an array library chooses to support prepend and append which are not of the same dtype as x, then behavior is implementation-defined.
5. kgryte

   added a commit that references this issue on Jan 9, 2025

   docs: clarify type promotion behavior in `diff`

   ...

   dcaf193
6. kgryte

   closed this as completedin #881on Jan 20, 2025
7. kgryte

   added a commit that references this issue on Jan 20, 2025

   docs: clarify type promotion behavior in `diff`

   ...

   52bbfeb