From 97d48ba60d7e0af9a204c2f03807c78d3397440d Mon Sep 17 00:00:00 2001 From: Bruno Oliveira Date: Sat, 9 Jun 2018 11:59:02 -0300 Subject: [PATCH] Add documentation blurb for --strict Fix #3549 --- changelog/3549.doc.rst | 1 + doc/en/mark.rst | 24 ++++++++++++++++++++++++ 2 files changed, 25 insertions(+) create mode 100644 changelog/3549.doc.rst diff --git a/changelog/3549.doc.rst b/changelog/3549.doc.rst new file mode 100644 index 000000000..62bc4f9a5 --- /dev/null +++ b/changelog/3549.doc.rst @@ -0,0 +1 @@ +Add documentation for the ``--strict`` flag. diff --git a/doc/en/mark.rst b/doc/en/mark.rst index e48135b10..753bd1c95 100644 --- a/doc/en/mark.rst +++ b/doc/en/mark.rst @@ -26,6 +26,30 @@ which also serve as documentation. :ref:`fixtures `. +Raising errors on unknown marks: --strict +----------------------------------------- + +The ``--strict`` command-line flag can be used to raise errors when marks not registered in the ``pytest.ini`` file. +Marks can be registered like this: + +.. code-block:: ini + + [pytest] + markers = + slow + serial + +This can be used to prevent users mistyping mark names by accident. Test suites that want to enforce that this +should add ``--strict`` to ``addopts``: + +.. code-block:: ini + + [pytest] + addopts = --strict + markers = + slow + serial + .. currentmodule:: _pytest.mark.structures .. autoclass:: Mark :members: