Merge pull request #9111 from ziebam/iss4320-better-docs-for-testdir-copy-example

nicoddemus · web-flow · commit f50652a5d2f3 · 2021-09-22T07:51:42.000-03:00
diff --git a/AUTHORS b/AUTHORS
@@ -224,6 +224,7 @@ Michael Goerz
 Michael Krebs
 Michael Seifert
 Michal Wajszczuk
+Michał Zięba
 Mihai Capotă
 Mike Hoyle (hoylemd)
 Mike Lundy
diff --git a/changelog/4320.doc.rst b/changelog/4320.doc.rst
@@ -0,0 +1 @@
+Improved docs for `pytester.copy_example`.
diff --git a/doc/en/how-to/writing_plugins.rst b/doc/en/how-to/writing_plugins.rst
@@ -416,7 +416,12 @@ return a result object, with which we can assert the tests' outcomes.
         result.assert_outcomes(passed=4)
 
 
-Additionally it is possible to copy examples for an example folder before running pytest on it.
+Additionally it is possible to copy examples to the ``pytester``'s isolated environment
+before running pytest on it. This way we can abstract the tested logic to separate files,
+which is especially useful for longer tests and/or longer ``conftest.py`` files.
+
+Note that for ``pytester.copy_example`` to work we need to set `pytester_example_dir`
+in our ``pytest.ini`` to tell pytest where to look for example files.
 
 .. code-block:: ini
 

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	+Improved docs for `pytester.copy_example`.