Skip to content

Commit 6ae3742

Browse files
committed
docs: update formatting
1 parent a42e827 commit 6ae3742

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

src/array_api_stubs/_draft/linear_algebra_functions.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,8 @@ def matmul(x1: array, x2: array, /) -> array:
4242
Raises
4343
------
4444
Error
45+
an exception **should** be raised in the following circumstances:
46+
4547
- if either ``x1`` or ``x2`` is a zero-dimensional array.
4648
- if ``x1`` is a one-dimensional array having shape ``(K,)``, ``x2`` is a one-dimensional array having shape ``(L,)``, and ``K != L``.
4749
- if ``x1`` is a one-dimensional array having shape ``(K,)``, ``x2`` is an array having shape ``(..., L, N)``, and ``K != L``.
@@ -153,6 +155,8 @@ def vecdot(x1: array, x2: array, /, *, axis: int = -1) -> array:
153155
Raises
154156
------
155157
Error
158+
an exception **should** be raised in the following circumstances:
159+
156160
- if the size of the axis over which to compute the dot product is not the same (before broadcasting) for both ``x1`` and ``x2``.
157161
158162
Notes

0 commit comments

Comments
 (0)