Merge pull request #156 from wholtz/patch-1

docs: pytest flags -k and -m are not supported
LUMC · Dec 7, 2022 · ef7f312 · ef7f312
2 parents 09e3ce5 + b2427b4
commit ef7f312
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/HISTORY.rst b/HISTORY.rst
@@ -34,6 +34,7 @@ version 2.0.0-dev
   7.0.0.
 + Throw a more descriptive error when a file copied with the --git-aware flag
   is not present on the filesystem anymore.
++ Document pytest flags ``-k`` and ``-m`` are not supported.
 
 version 1.6.0
 ---------------------------

diff --git a/docs/running_pytest_workflow.rst b/docs/running_pytest_workflow.rst
@@ -129,3 +129,9 @@ Internally names and tags are handled the same so if the following tests:
       - hello
 
 are run with ``pytest --tag hello`` then both ``hello`` and ``hello2`` are run.
+
+.. note::
+
+    The pytest flags ``-k`` and ``-m`` are not supported by pytest-workflow.
+    Rational for this design decision can be `found within GitHub issue #155
+    <https://github.com/LUMC/pytest-workflow/issues/155#issuecomment-1334911457>`_.