Document test discovery naming conventions (#172)

* docs: conventions for test discovery * docs: update HISTORY.rst * add back end of file newline * use version indepdent URL
LUMC · Jan 20, 2023 · f81a588 · f81a588
1 parent 4add25a
commit f81a588
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/HISTORY.rst b/HISTORY.rst
@@ -7,6 +7,10 @@ Changelog
 .. This document is user facing. Please word the changes in such a way
 .. that users understand how the changes affect the new version.
 
+version 2.1.0-dev
+---------------------------
+* Document naming conventions for Python test discovery
+
 version 2.0.1
 ---------------------------
 + Fixed a bug where pytest-workflow would crash on logs that used non-ASCII

diff --git a/docs/writing_tests.rst b/docs/writing_tests.rst
@@ -160,6 +160,10 @@ Multiple workflows can use the same custom test like this:
 points to the folder where the named workflow was executed. This allows writing
 of advanced python tests for each file produced by the workflow.
 
+Custom tests must follow the `conventions for Python test discovery
+<https://docs.pytest.org/en/latest/explanation/goodpractices.html#conventions-for-python-test-discovery>`_,
+which constrains the names of files and functions containing custom tests.
+
 .. note::
 
     stdout and stderr are available as files in the root of the