From 52bbfebe4f5f4795063bdbcc4abd48a413bb9a3f Mon Sep 17 00:00:00 2001 From: Athan Date: Mon, 20 Jan 2025 01:26:23 -0800 Subject: [PATCH] docs: clarify type promotion behavior in `diff` PR-URL: https://github.com/data-apis/array-api/pull/881 Closes: https://github.com/data-apis/array-api/issues/852 Reviewed-by: Ralf Gommers --- src/array_api_stubs/_draft/utility_functions.py | 1 + 1 file changed, 1 insertion(+) diff --git a/src/array_api_stubs/_draft/utility_functions.py b/src/array_api_stubs/_draft/utility_functions.py index cdbe4a0f8..7a234efbb 100644 --- a/src/array_api_stubs/_draft/utility_functions.py +++ b/src/array_api_stubs/_draft/utility_functions.py @@ -125,4 +125,5 @@ def diff( ----- - The first-order differences are given by ``out[i] = x[i+1] - x[i]`` along a specified axis. Higher-order differences must be calculated recursively (e.g., by calling ``diff(out, axis=axis, n=n-1)``). + - If a conforming implementation chooses to support ``prepend`` and ``append`` arrays which have a different data type than ``x``, behavior is unspecified and thus implementation-defined. Implementations may choose to type promote (:ref:`type-promotion`), cast ``prepend`` and/or ``append`` to the same data type as ``x``, or raise an exception. """