Skip to content

📝 Add Array API spec links to protocol docstrings #68

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.

Sign up for GitHub

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

Open
fbourgey wants to merge 1 commit into
base: main
Choose a base branch
from
+4 −0
Open

📝 Add Array API spec links to protocol docstrings #68

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 4 additions & 0 deletions src/array_api_typing/_array.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@
class HasArrayNamespace(Protocol[NamespaceT_co]):
"""Protocol for classes that have an `__array_namespace__` method.
See the Array API specification: https://data-apis.org/array-api/latest/
This `Protocol` is intended for use in static typing to ensure that an
object has an `__array_namespace__` method that returns a namespace for
array operations. This `Protocol` should not be used at runtime for type
Expand Down Expand Up @@ -76,6 +78,8 @@ class Array(
):
"""Array API specification for array object attributes and methods.
See the Array API specification: https://data-apis.org/array-api/latest/
The type is: ``Array[+DTypeT, +NamespaceT = ModuleType] = Array[DTypeT,
NamespaceT]`` where:
Expand Down
Loading