Skip to content

Commit cfe5d60

Browse files
committed
docs: add note regarding unspecified behavior for 0d input
1 parent 3b2386e commit cfe5d60

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

src/array_api_stubs/_draft/statistical_functions.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ def cumulative_prod(
2828
Parameters
2929
----------
3030
x: array
31-
input array. Should have a numeric data type.
31+
input array. Should have one or more dimensions (axes). Should have a numeric data type.
3232
axis: Optional[int]
3333
axis along which a cumulative product must be computed. If ``axis`` is negative, the function must determine the axis along which to compute a cumulative product by counting from the last dimension.
3434
@@ -58,6 +58,8 @@ def cumulative_prod(
5858
Notes
5959
-----
6060
61+
- When ``x`` is a zero-dimensional array, behavior is unspecified and thus implementation-defined.
62+
6163
**Special Cases**
6264
6365
For both real-valued and complex floating-point operands, special cases must be handled as if the operation is implemented by successive application of :func:`~array_api.multiply`.

0 commit comments

Comments
 (0)