Skip to content

Include __array_api_version__ in API specification section #480

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

Merged
merged 3 commits into from
Oct 17, 2022
Merged

Include __array_api_version__ in API specification section #480

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d632f24
`__array_api_version__` docs
honno Sep 21, 2022
8a305c5
Use `:nosignatures:` for `version.rst` auto-summary
honno Sep 21, 2022
1b0491b
Assign `__array_api_version__` stub to `"YYYY.MM"
honno Oct 6, 2022
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
6 changes: 6 additions & 0 deletions spec/API_specification/array_api/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,9 @@
from .statistical_functions import *
from .utility_functions import *
from . import linalg


__array_api_version__: str = "YYYY.MM"
"""
String representing the version of the array API specification which the conforming implementation adheres to.
"""
1 change: 1 addition & 0 deletions spec/API_specification/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,4 @@ API specification
statistical_functions
type_promotion
utility_functions
version
22 changes: 22 additions & 0 deletions spec/API_specification/version.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
Version
=======

Array API specification for versioning.

A conforming implementation of the array API standard must provide a `__array_api_version__` attribute - see :ref:`api-versioning` for details.


Objects in API
--------------

.. currentmodule:: array_api

..
NOTE: please keep the functions in alphabetical order

.. autosummary::
:toctree: generated
:template: attribute.rst
:nosignatures:

__array_api_version__