Skip to content

Commit

Permalink
fix: clarify broadcast behavior in broadcast_to
Browse files Browse the repository at this point in the history
PR-URL: #888
Closes: #823
  • Loading branch information
kgryte authored Feb 6, 2025
1 parent 7adeae8 commit 4f26831
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions src/array_api_stubs/_draft/manipulation_functions.py
Original file line number Diff line number Diff line change
Expand Up @@ -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``.
"""


Expand Down

0 comments on commit 4f26831

Please sign in to comment.