From ba1ad7d517a9e67ae80bc6c644faf288e7c4ed99 Mon Sep 17 00:00:00 2001
From: Florian Bruhin <me@the-compiler.org>
Date: Mon, 28 Jun 2021 19:47:49 +0200
Subject: [PATCH] Opt-out from regendoc for problematic example (#8810)
* Opt-out from regendoc for problematic example
See #8807
* Add comment
---
doc/en/how-to/skipping.rst | 5 ++++-
1 file changed, 4 insertions(+), 1 deletion(-)
diff --git a/doc/en/how-to/skipping.rst b/doc/en/how-to/skipping.rst
index 263732632..156570062 100644
--- a/doc/en/how-to/skipping.rst
+++ b/doc/en/how-to/skipping.rst
@@ -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