Skip to content

Commit df7ffe3

Browse files
committed
Remove recommendation to use -o xfail_strict=True
1 parent 78a5b20 commit df7ffe3

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -212,9 +212,13 @@ array_api_tests/test_set_functions.py
212212
Here is an example GitHub Actions workflow file, where the xfails are stored
213213
in `array-api-tests.xfails.txt` in the base of the `your-array-library` repo.
214214

215-
Note that this uses `-o xfail_strict=True`. This causes XPASS tests (XFAIL
216-
tests that actually pass) to fail the test suite. If you don't want this
217-
behavior, you can remove it, or use `--skips-file` instead of `--xfails-file`.
215+
If you want, you can use `-o xfail_strict=True`, which causes XPASS tests (XFAIL
216+
tests that actually pass) to fail the test suite. However, be aware that
217+
XFAILures can be flaky (see below, so this may not be a good idea unless you
218+
use some other mitigation of such flakyness).
219+
220+
If you don't want this behavior, you can remove it, or use `--skips-file`
221+
instead of `--xfails-file`.
218222

219223
```yaml
220224
# ./.github/workflows/array_api.yml
@@ -244,7 +248,7 @@ jobs:
244248
run: |
245249
export PYTHONPATH="${GITHUB_WORKSPACE}/array-api-compat"
246250
cd ${GITHUB_WORKSPACE}/array-api-tests
247-
pytest -v -rxXfE --ci -o xfail_strict=True --xfails-file ${GITHUB_WORKSPACE}/your-array-library/array-api-tests-xfails.txt array_api_tests/
251+
pytest -v -rxXfE --ci --xfails-file ${GITHUB_WORKSPACE}/your-array-library/array-api-tests-xfails.txt array_api_tests/
248252
```
249253
250254
> **Warning**

0 commit comments

Comments
 (0)