diff --git a/changelog/3833.doc.rst b/changelog/3833.doc.rst new file mode 100644 index 000000000..254e2e4b6 --- /dev/null +++ b/changelog/3833.doc.rst @@ -0,0 +1 @@ +Added missing docs for ``pytester.Testdir`` diff --git a/doc/en/reference.rst b/doc/en/reference.rst index 86d92cf07..484c755da 100644 --- a/doc/en/reference.rst +++ b/doc/en/reference.rst @@ -460,7 +460,7 @@ To use it, include in your top-most ``conftest.py`` file:: .. autoclass:: Testdir() - :members: runpytest,runpytest_subprocess,runpytest_inprocess,makeconftest,makepyfile + :members: .. autoclass:: RunResult() :members: diff --git a/src/_pytest/pytester.py b/src/_pytest/pytester.py index 5b42b81ee..b40a9e267 100644 --- a/src/_pytest/pytester.py +++ b/src/_pytest/pytester.py @@ -550,18 +550,22 @@ class Testdir(object): return ret def makefile(self, ext, *args, **kwargs): - """Create a new file in the testdir. + r"""Create new file(s) in the testdir. - ext: The extension the file should use, including the dot, e.g. `.py`. - - args: All args will be treated as strings and joined using newlines. + :param str ext: The extension the file(s) should use, including the dot, e.g. `.py`. + :param list[str] args: All args will be treated as strings and joined using newlines. The result will be written as contents to the file. The name of the file will be based on the test function requesting this fixture. - E.g. "testdir.makefile('.txt', 'line1', 'line2')" - - kwargs: Each keyword is the name of a file, while the value of it will + :param kwargs: Each keyword is the name of a file, while the value of it will be written as contents of the file. - E.g. "testdir.makefile('.ini', pytest='[pytest]\naddopts=-rs\n')" + + Examples: + + .. code-block:: python + + testdir.makefile(".txt", "line1", "line2") + + testdir.makefile(".ini", pytest="[pytest]\naddopts=-rs\n") """ return self._makefile(ext, args, kwargs)