From d632f24a9d67ad90967154e62398cdfe19fcd370 Mon Sep 17 00:00:00 2001 From: Matthew Barber Date: Wed, 21 Sep 2022 12:18:15 +0100 Subject: [PATCH 1/3] `__array_api_version__` docs --- spec/API_specification/array_api/__init__.py | 6 ++++++ spec/API_specification/index.rst | 1 + spec/API_specification/version.rst | 21 ++++++++++++++++++++ 3 files changed, 28 insertions(+) create mode 100644 spec/API_specification/version.rst diff --git a/spec/API_specification/array_api/__init__.py b/spec/API_specification/array_api/__init__.py index e5de2e49f..350dd9fb0 100644 --- a/spec/API_specification/array_api/__init__.py +++ b/spec/API_specification/array_api/__init__.py @@ -12,3 +12,9 @@ from .statistical_functions import * from .utility_functions import * from . import linalg + + +__array_api_version__: str = "2021.12" +""" +String representing the version of the array API specification which the conforming implementation adheres to. +""" diff --git a/spec/API_specification/index.rst b/spec/API_specification/index.rst index 1d4c9cfef..775344482 100644 --- a/spec/API_specification/index.rst +++ b/spec/API_specification/index.rst @@ -24,3 +24,4 @@ API specification statistical_functions type_promotion utility_functions + version diff --git a/spec/API_specification/version.rst b/spec/API_specification/version.rst new file mode 100644 index 000000000..ab5aa8b44 --- /dev/null +++ b/spec/API_specification/version.rst @@ -0,0 +1,21 @@ +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 + + __array_api_version__ From 8a305c55cfaee97332ab02f85e51cc1ab9f8efed Mon Sep 17 00:00:00 2001 From: Matthew Barber Date: Wed, 21 Sep 2022 12:26:54 +0100 Subject: [PATCH 2/3] Use `:nosignatures:` for `version.rst` auto-summary --- spec/API_specification/version.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/spec/API_specification/version.rst b/spec/API_specification/version.rst index ab5aa8b44..346395d9a 100644 --- a/spec/API_specification/version.rst +++ b/spec/API_specification/version.rst @@ -17,5 +17,6 @@ Objects in API .. autosummary:: :toctree: generated :template: attribute.rst + :nosignatures: __array_api_version__ From 1b0491be3731b36eae0b71fc6ee0fd320eb3db62 Mon Sep 17 00:00:00 2001 From: Matthew Barber Date: Thu, 6 Oct 2022 12:43:00 +0100 Subject: [PATCH 3/3] Assign `__array_api_version__` stub to `"YYYY.MM" --- spec/API_specification/array_api/__init__.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/spec/API_specification/array_api/__init__.py b/spec/API_specification/array_api/__init__.py index 350dd9fb0..50fe5070b 100644 --- a/spec/API_specification/array_api/__init__.py +++ b/spec/API_specification/array_api/__init__.py @@ -14,7 +14,7 @@ from . import linalg -__array_api_version__: str = "2021.12" +__array_api_version__: str = "YYYY.MM" """ String representing the version of the array API specification which the conforming implementation adheres to. """ 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