docs: clarify type promotion behavior in diff

PR-URL: #881 Closes: #852 Reviewed-by: Ralf Gommers <[email protected]>
data-apis · Jan 20, 2025 · 52bbfeb · 52bbfeb
1 parent 532db5b
commit 52bbfeb
Showing 1 changed file with 1 addition and 0 deletions.
diff --git 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.
     """