Skip to content

Commit d6c9ec8

Browse files
committed
docs: add note concerning out-of-bounds behavior
1 parent 804843c commit d6c9ec8

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

src/array_api_stubs/_draft/indexing_functions.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,10 @@ def take_along_axis(x: array, indices: array, /, *, axis: int = -1) -> array:
5050
input array. Must be compatible with ``indices``, except for the axis (dimension) specified by ``axis`` (see :ref:`broadcasting`).
5151
indices: array
5252
array indices. Must have the same rank (i.e., number of dimensions) as ``x``.
53+
54+
.. note::
55+
This specification does not require bounds checking. The behavior for out-of-bounds indices is left unspecified.
56+
5357
axis: int
5458
axis along which to select values. If ``axis`` is negative, the function must determine the axis along which to select values by counting from the last dimension. Default: ``-1``.
5559

0 commit comments

Comments
 (0)