Skip to content

docs: move notes below the fold and highlight RFC 2119 keywords #955

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Jun 12, 2025
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
docs: update formatting
  • Loading branch information
kgryte committed Jun 9, 2025
commit 6ae3742df0c007d4e611e982b20218ce500dc3ae
4 changes: 4 additions & 0 deletions src/array_api_stubs/_draft/linear_algebra_functions.py
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,8 @@ def matmul(x1: array, x2: array, /) -> array:
Raises
------
Error
an exception **should** be raised in the following circumstances:

- if either ``x1`` or ``x2`` is a zero-dimensional array.
- if ``x1`` is a one-dimensional array having shape ``(K,)``, ``x2`` is a one-dimensional array having shape ``(L,)``, and ``K != L``.
- if ``x1`` is a one-dimensional array having shape ``(K,)``, ``x2`` is an array having shape ``(..., L, N)``, and ``K != L``.
Expand Down Expand Up @@ -153,6 +155,8 @@ def vecdot(x1: array, x2: array, /, *, axis: int = -1) -> array:
Raises
------
Error
an exception **should** be raised in the following circumstances:

- if the size of the axis over which to compute the dot product is not the same (before broadcasting) for both ``x1`` and ``x2``.

Notes
Expand Down
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy