From dddf362afb3b14d986f38f8689b96ee9e51027a1 Mon Sep 17 00:00:00 2001 From: Athan Reines Date: Thu, 23 Jan 2025 02:12:02 -0800 Subject: [PATCH] fix: clarify broadcast behavior in `broadcast_to` Closes: https://github.com/data-apis/array-api/issues/823 --- src/array_api_stubs/_draft/manipulation_functions.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/array_api_stubs/_draft/manipulation_functions.py b/src/array_api_stubs/_draft/manipulation_functions.py index 131b81eb3..c09f2643b 100644 --- a/src/array_api_stubs/_draft/manipulation_functions.py +++ b/src/array_api_stubs/_draft/manipulation_functions.py @@ -42,14 +42,14 @@ def broadcast_to(x: array, /, shape: Tuple[int, ...]) -> array: Parameters ---------- x: array - array to broadcast. + array to broadcast. Must be capable of being broadcast to the specified ``shape`` (see :ref:`broadcasting`). If the array is incompatible with the specified shape, the function should raise an exception. shape: Tuple[int, ...] - array shape. Must be compatible with ``x`` (see :ref:`broadcasting`). If the array is incompatible with the specified shape, the function should raise an exception. + array shape. Returns ------- out: array - an array having a specified shape. Must have the same data type as ``x``. + an array having the specified shape. Must have the same data type as ``x``. """