jiuyuan
/
test_ok1
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

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

5669: pytester: add docstrings for Testdir.copy_example
This commit is contained in:
Bruno Oliveira 2019-08-10 09:00:42 -03:00 committed by GitHub
parent 8ffa3aa65d ee936b27a8
commit f7e81dab9a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
changelog/5669.doc.rst Normal file
View File

@ -0,0 +1 @@
Add docstring for ``Testdir.copy_example``.

6
src/_pytest/pytester.py
View File

@ -630,6 +630,12 @@ class Testdir:
return p return p
def copy_example(self, name=None): 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 import warnings
from _pytest.warning_types import PYTESTER_COPY_EXAMPLE from _pytest.warning_types import PYTESTER_COPY_EXAMPLE