Skip to content

Commit a85563a

Browse files
committed
Highlight specifying API version in README
1 parent 478d976 commit a85563a

File tree

1 file changed

+13
-8
lines changed

1 file changed

+13
-8
lines changed

README.md

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -33,11 +33,23 @@ You need to specify the array library to test. It can be specified via the
3333
`ARRAY_API_TESTS_MODULE` environment variable, e.g.
3434

3535
```bash
36-
$ export ARRAY_API_TESTS_MODULE=numpy.array_api
36+
$ export ARRAY_API_TESTS_MODULE=array_api_strict
3737
```
3838

3939
Alternately, import/define the `xp` variable in `array_api_tests/__init__.py`.
4040

41+
### Specifying the API version
42+
43+
You can specify the API version to use when testing via the
44+
`ARRAY_API_TESTS_VERSION` environment variable, e.g.
45+
46+
```bash
47+
$ export ARRAY_API_TESTS_VERSION="2023.12"
48+
```
49+
50+
Currently this defaults to the array module's `__array_api_version__` value, and
51+
if that attribute doesn't exist then we fallback to `"2021.12"`.
52+
4153
### Run the suite
4254

4355
Simply run `pytest` against the `array_api_tests/` folder to run the full suite.
@@ -154,13 +166,6 @@ library to fail.
154166

155167
### Configuration
156168

157-
#### API version
158-
159-
You can specify the API version to use when testing via the
160-
`ARRAY_API_TESTS_VERSION` environment variable. Currently this defaults to the
161-
array module's `__array_api_version__` value, and if that attribute doesn't
162-
exist then we fallback to `"2021.12"`.
163-
164169
#### Data-dependent shapes
165170

166171
Use the `--disable-data-dependent-shapes` flag to skip testing functions which have

0 commit comments

Comments
 (0)