Skip to content

Commit dcaf193

Browse files
committed
docs: clarify type promotion behavior in diff
Closes: data-apis#852
1 parent fd6f507 commit dcaf193

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

src/array_api_stubs/_draft/utility_functions.py

+1
Original file line numberDiff line numberDiff line change
@@ -125,4 +125,5 @@ def diff(
125125
-----
126126
127127
- 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)``).
128+
- If a conforming implementation chooses to support ``prepend`` and ``append`` arrays which have a different data type than ``x``, the ``prepend`` and ``append`` arrays should promote to the same data type as ``x`` (see :ref:`type-promotion`). If ``prepend`` and ``append`` do not promote to the same data type as ``x`` or are of a different data type "kind" (integer, real-valued floating-point, or complex floating-point), behavior is unspecified and thus implementation-defined.
128129
"""

0 commit comments

Comments
 (0)