Clarify docs on --strict marks
This commit is contained in:
parent
f494eefcae
commit
d9bdf5cfca
|
@ -29,9 +29,11 @@ which also serve as documentation.
|
||||||
Raising errors on unknown marks: --strict
|
Raising errors on unknown marks: --strict
|
||||||
-----------------------------------------
|
-----------------------------------------
|
||||||
|
|
||||||
When the ``--strict`` command-line flag is passed, any marks not registered in the ``pytest.ini`` file will trigger an error.
|
When the ``--strict`` command-line flag is passed, any unknown marks applied
|
||||||
|
with the ``@pytest.mark.name_of_the_mark`` decorator will trigger an error.
|
||||||
|
Marks defined or added by pytest or by a plugin will not trigger an error.
|
||||||
|
|
||||||
Marks can be registered like this:
|
Marks can be registered in ``pytest.ini`` like this:
|
||||||
|
|
||||||
.. code-block:: ini
|
.. code-block:: ini
|
||||||
|
|
||||||
|
|
|
@ -1226,8 +1226,11 @@ passed multiple times. The expected format is ``name=value``. For example::
|
||||||
|
|
||||||
.. confval:: markers
|
.. confval:: markers
|
||||||
|
|
||||||
List of markers that are allowed in test functions, enforced when ``--strict`` command-line argument is used.
|
When the ``--strict`` command-line argument is used, only known markers -
|
||||||
You can use a marker name per line, indented from the option name.
|
defined in code by core pytest or some plugin - are allowed.
|
||||||
|
You can list additional markers in this setting to add them to the whitelist.
|
||||||
|
|
||||||
|
You can list one marker name per line, indented from the option name.
|
||||||
|
|
||||||
.. code-block:: ini
|
.. code-block:: ini
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue