Opt-out from regendoc for problematic example (#8810)

* Opt-out from regendoc for problematic example

See #8807

* Add comment
This commit is contained in:
Florian Bruhin 2021-06-28 19:47:49 +02:00 committed by GitHub
parent c4c3b6d4fd
commit ba1ad7d517
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 1 deletions

View File

@ -369,9 +369,12 @@ Here is a simple test file with the several usages:
Running it with the report-on-xfail option gives this output:
.. FIXME: Use $ instead of ! again to reenable regendoc once it's fixed:
https://github.com/pytest-dev/pytest/issues/8807
.. code-block:: pytest
example $ pytest -rx xfail_demo.py
! pytest -rx xfail_demo.py
=========================== test session starts ============================
platform linux -- Python 3.x.y, pytest-6.x.y, py-1.x.y, pluggy-0.x.y
cachedir: $PYTHON_PREFIX/.pytest_cache