floraachy
/
pytest2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

pytester: add docstrings for Testdir.copy_example

This commit is contained in:
martbln 2019-08-10 00:55:39 +03:00
parent 5ecac3c861
commit e0ce8b79d5
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: self.tmpdir
"""
import warnings import warnings
from _pytest.warning_types import PYTESTER_COPY_EXAMPLE from _pytest.warning_types import PYTESTER_COPY_EXAMPLE