Skip to content

Commit dddf362

Browse files
committed
fix: clarify broadcast behavior in broadcast_to
Closes: data-apis#823
1 parent 52bbfeb commit dddf362

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

src/array_api_stubs/_draft/manipulation_functions.py

+3-3
Original file line numberDiff line numberDiff line change
@@ -42,14 +42,14 @@ def broadcast_to(x: array, /, shape: Tuple[int, ...]) -> array:
4242
Parameters
4343
----------
4444
x: array
45-
array to broadcast.
45+
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.
4646
shape: Tuple[int, ...]
47-
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.
47+
array shape.
4848
4949
Returns
5050
-------
5151
out: array
52-
an array having a specified shape. Must have the same data type as ``x``.
52+
an array having the specified shape. Must have the same data type as ``x``.
5353
"""
5454

5555

0 commit comments

Comments
 (0)