docs: clarify behavior when providing a zero-dimensional array to take

PR-URL: #876 Co-authored-by: Athan Reines <[email protected]> Reviewed-by: Athan Reines <[email protected]>
data-apis · Jan 9, 2025 · 456d186 · 456d186
1 parent 7757e67
commit 456d186
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/src/array_api_stubs/_draft/indexing_functions.py b/src/array_api_stubs/_draft/indexing_functions.py
@@ -13,7 +13,7 @@ def take(x: array, indices: array, /, *, axis: Optional[int] = None) -> array:
     Parameters
     ----------
     x: array
-        input array.
+        input array. Should have one or more dimensions (axes).
     indices: array
         array indices. The array must be one-dimensional and have an integer data type.
 
@@ -33,6 +33,8 @@ def take(x: array, indices: array, /, *, axis: Optional[int] = None) -> array:
     Notes
     -----
 
+    -   When ``x`` is a zero-dimensional array, behavior is unspecified and thus implementation-defined.
+
     .. versionadded:: 2022.12
 
     .. versionchanged:: 2023.12