10000 Small updates to the array_api docs · melissawm/numpy@51dd7aa · GitHub
[go: up one dir, main page]

Skip to content

Commit 51dd7aa

Browse files
asmeurermelissawm
authored andcommitted
Small updates to the array_api docs
These items were not clear in the original PR numpy#21260 but have since been clarified.
1 parent d694517 commit 51dd7aa

File tree

1 file changed

+4
-5
lines changed

1 file changed

+4
-5
lines changed

doc/source/reference/array_api.rst

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -624,11 +624,8 @@ Linear Algebra Differences
624624
* - ``cholesky`` includes an ``upper`` keyword argument.
625625
- **Compatible**
626626
-
627-
* - ``cross`` does not broadcast its arguments.
628-
- ???
629-
-
630627
* - ``cross`` does not allow size 2 vectors (only size 3).
631-
- ???
628+
- **Breaking**
632629
-
633630
* - ``diagonal`` operates on the last two axes.
634631
- **Breaking**
@@ -663,7 +660,9 @@ Linear Algebra Differences
663660
<https://data-apis.org/array-api/latest/API_specification/generated/signatures.linear_algebra_functions.matrix_transpose.html#signatures.linear_algebra_functions.matrix_transpose>`__
664661
* - ``outer`` only supports 1-dimensional arrays.
665662
- **Breaking**
666-
-
663+
- The spec currently only specifies behavior on 1-D arrays but future
664+
behavior will likely be to broadcast, rather than flatten, which is
665+
what ``np.outer`` does.
667666
* - ``pinv`` has an ``rtol`` keyword argument instead of ``rcond``
668667
- **Breaking**
669668
- The meaning of ``rtol`` and ``rcond`` is the same, but the default

0 commit comments

Comments
 (0)
0