Uppercase first word in docstrings. Change to an imperative form. Add name to authors.

This commit is contained in:
Javi Romero 2016-07-22 12:39:06 +02:00
parent 14af12cb7b
commit 7e37497d5a
6 changed files with 10 additions and 9 deletions

View File

@ -96,3 +96,4 @@ Tom Viner
Trevor Bekolay Trevor Bekolay
Wouter van Ackooy Wouter van Ackooy
Bernard Pratz Bernard Pratz
Javier Romero

View File

@ -156,7 +156,7 @@ error_capsysfderror = "cannot use capsys and capfd at the same time"
@pytest.fixture @pytest.fixture
def capsys(request): def capsys(request):
"""enables capturing of writes to sys.stdout/sys.stderr and makes """Enable capturing of writes to sys.stdout/sys.stderr and make
captured output available via ``capsys.readouterr()`` method calls captured output available via ``capsys.readouterr()`` method calls
which return a ``(out, err)`` tuple. which return a ``(out, err)`` tuple.
""" """
@ -167,7 +167,7 @@ def capsys(request):
@pytest.fixture @pytest.fixture
def capfd(request): def capfd(request):
"""enables capturing of writes to file descriptors 1 and 2 and makes """Enable capturing of writes to file descriptors 1 and 2 and make
captured output available via ``capfd.readouterr()`` method calls captured output available via ``capfd.readouterr()`` method calls
which return a ``(out, err)`` tuple. which return a ``(out, err)`` tuple.
""" """

View File

@ -186,8 +186,8 @@ class _NodeReporter(object):
@pytest.fixture @pytest.fixture
def record_xml_property(request): def record_xml_property(request):
"""Fixture that adds extra xml properties to the tag for the calling test. """Add extra xml properties to the tag for the calling test.
The fixture is callable with (name, value), with value being automatically The fixture is callable with ``(name, value)``, with value being automatically
xml-encoded. xml-encoded.
""" """
request.node.warn( request.node.warn(

View File

@ -9,7 +9,7 @@ RE_IMPORT_ERROR_NAME = re.compile("^No module named (.*)$")
def pytest_funcarg__monkeypatch(request): def pytest_funcarg__monkeypatch(request):
"""The returned ``monkeypatch`` funcarg provides these """Return a ``monkeypatch`` funcarg providing the following
helper methods to modify objects, dictionaries or os.environ:: helper methods to modify objects, dictionaries or os.environ::
monkeypatch.setattr(obj, name, value, raising=True) monkeypatch.setattr(obj, name, value, raising=True)

View File

@ -271,7 +271,7 @@ def pytest_namespace():
@fixture(scope="session") @fixture(scope="session")
def pytestconfig(request): def pytestconfig(request):
""" the pytest config object with access to command line opts.""" """ The pytest config object with access to command line opts."""
return request.config return request.config

View File

@ -108,7 +108,7 @@ def tmpdir_factory(request):
@pytest.fixture @pytest.fixture
def tmpdir(request, tmpdir_factory): def tmpdir(request, tmpdir_factory):
"""return a temporary directory path object """Return a temporary directory path object
which is unique to each test function invocation, which is unique to each test function invocation,
created as a sub directory of the base temporary created as a sub directory of the base temporary
directory. The returned object is a `py.path.local`_ directory. The returned object is a `py.path.local`_