Skip to content

Commit 8333107

Browse files
committed
Update documentation for 2023.12 support
1 parent 05fa0b5 commit 8333107

File tree

3 files changed

+14
-8
lines changed

3 files changed

+14
-8
lines changed

array_api_strict/_flags.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,10 +71,9 @@ def set_array_api_strict_flags(
7171
Note that 2021.12 is supported, but currently gives the same thing as
7272
2022.12 (except that the fft extension will be disabled).
7373
74-
2023.12 support is preliminary. Some features in 2023.12 may still be
74+
2023.12 support is experimental. Some features in 2023.12 may still be
7575
missing, and it hasn't been fully tested.
7676
77-
7877
- `boolean_indexing`: Whether indexing by a boolean array is supported.
7978
Note that although boolean array indexing does result in data-dependent
8079
shapes, this flag is independent of the `data_dependent_shapes` flag

docs/api.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ Array API Strict Flags
1111
.. currentmodule:: array_api_strict
1212

1313
.. autofunction:: get_array_api_strict_flags
14+
15+
.. _set_array_api_strict_flags:
1416
.. autofunction:: set_array_api_strict_flags
1517
.. autofunction:: reset_array_api_strict_flags
1618
.. autoclass:: ArrayAPIStrictFlags

docs/index.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,12 @@ libraries. Consuming library code should use the
1515
support the array API. Rather, it is intended to be used in the test suites of
1616
consuming libraries to test their array API usage.
1717

18-
array-api-strict currently supports the 2022.12 version of the standard.
19-
2023.12 support is planned and is tracked by [this
20-
issue](https://github.com/data-apis/array-api-strict/issues/25).
18+
array-api-strict currently supports the
19+
[2022.12](https://data-apis.org/array-api/latest/changelog.html#v2022-12)
20+
version of the standard. Experimental
21+
[2023.12](https://data-apis.org/array-api/latest/changelog.html#v2023-12)
22+
support is implemented, [but must be enabled with a
23+
flag](set_array_api_strict_flags).
2124

2225
## Install
2326

@@ -179,9 +182,11 @@ issue, but this hasn't necessarily been tested thoroughly.
179182
function. array-api-strict currently implements all of these. In the
180183
future, [there may be a way to disable them](https://github.com/data-apis/array-api-strict/issues/7).
181184

182-
6. array-api-strict currently only supports the 2022.12 version of the array
183-
API standard. [Support for 2023.12 is
184-
planned](https://github.com/data-apis/array-api-strict/issues/25).
185+
6. array-api-strict currently uses the 2022.12 version of the array API
186+
standard. Support for 2023.12 is implemented but is still experimental and
187+
not fully tested. It can be enabled with
188+
[`array_api_strict.set_array_api_strict_flags(api_version='2023.12')`](set_array_api_strict_flags).
189+
185190

186191
(numpy.array_api)=
187192
## Relationship to `numpy.array_api`

0 commit comments

Comments
 (0)