Skip to content

Commit e98dafc

Browse files
committed
docs: update copy
1 parent 41abe30 commit e98dafc

File tree

1 file changed

+2
-4
lines changed

1 file changed

+2
-4
lines changed

src/array_api_stubs/_draft/manipulation_functions.py

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ def broadcast_shapes(*shapes: Tuple[int, ...]) -> Tuple[int, ...]:
4848
Returns
4949
-------
5050
out: Tuple[int, ...]
51-
a broadcasted shape.
51+
a single broadcasted shape obtained by applying broadcasting rules (see :ref:`broadcasting`) to each of the input shapes against one another.
5252
5353
Raises
5454
------
@@ -59,9 +59,7 @@ def broadcast_shapes(*shapes: Tuple[int, ...]) -> Tuple[int, ...]:
5959
-----
6060
6161
- If not provided one or more arguments, the function **must** return an empty tuple.
62-
63-
.. note::
64-
Array libraries which build computation graphs (e.g., ndonnx and Dask) commonly support shapes having dimensions of unknown size. If a shape contains a value other than an integer (e.g., ``None`` for a dimension of unknown size), behavior is unspecified and thus implementation-defined. Array-conforming libraries **may** choose to propagate such values (e.g., if a shape contains a dimension size of ``None``, the returned broadcasted shape also has a corresponding dimension having a size equal to ``None``) or raise an exception.
62+
- Array libraries which build computation graphs (e.g., ndonnx and Dask) commonly support shapes having dimensions of unknown size. If a shape contains a value other than an integer (e.g., ``None`` for a dimension of unknown size), array-conforming libraries **must** propagate such values (e.g., if a shape contains a dimension size of ``None``, the returned broadcasted shape also has a corresponding dimension having a size equal to ``None``).
6563
"""
6664

6765

0 commit comments

Comments
 (0)