5669: pytester: add docstrings for Testdir.copy_example (#5719)

5669: pytester: add docstrings for Testdir.copy_example
2019-08-10 09:00:42 -03:00
parent 8ffa3aa65d ee936b27a8
commit f7e81dab9a
2 changed files with 7 additions and 0 deletions
--- a/src/_pytest/pytester.py
+++ b/src/_pytest/pytester.py
@@ -630,6 +630,12 @@ class Testdir:
        return p

    def copy_example(self, name=None):
+        """Copy file from project's directory into the testdir.
+
+        :param str name: The name of the file for copy.
+        :return: path to the copied directory (inside ``self.tmpdir``).
+
+        """
        import warnings
        from _pytest.warning_types import PYTESTER_COPY_EXAMPLE