Merge pull request #2354 from shobute/patch-1

Corrected documentation typo in fixtures.py
This commit is contained in:
Bruno Oliveira 2017-04-07 14:31:36 -03:00 committed by GitHub
commit 47a2a77cb4
1 changed files with 10 additions and 10 deletions

View File

@ -841,8 +841,8 @@ class FixtureFunctionMarker:
def fixture(scope="function", params=None, autouse=False, ids=None, name=None): def fixture(scope="function", params=None, autouse=False, ids=None, name=None):
""" (return a) decorator to mark a fixture factory function. """ (return a) decorator to mark a fixture factory function.
This decorator can be used (with or or without parameters) to define This decorator can be used (with or without parameters) to define a
a fixture function. The name of the fixture function can later be fixture function. The name of the fixture function can later be
referenced to cause its invocation ahead of running tests: test referenced to cause its invocation ahead of running tests: test
modules or classes can use the pytest.mark.usefixtures(fixturename) modules or classes can use the pytest.mark.usefixtures(fixturename)
marker. Test functions can directly use fixture names as input marker. Test functions can directly use fixture names as input
@ -861,16 +861,16 @@ def fixture(scope="function", params=None, autouse=False, ids=None, name=None):
reference is needed to activate the fixture. reference is needed to activate the fixture.
:arg ids: list of string ids each corresponding to the params :arg ids: list of string ids each corresponding to the params
so that they are part of the test id. If no ids are provided so that they are part of the test id. If no ids are provided
they will be generated automatically from the params. they will be generated automatically from the params.
:arg name: the name of the fixture. This defaults to the name of the :arg name: the name of the fixture. This defaults to the name of the
decorated function. If a fixture is used in the same module in decorated function. If a fixture is used in the same module in
which it is defined, the function name of the fixture will be which it is defined, the function name of the fixture will be
shadowed by the function arg that requests the fixture; one way shadowed by the function arg that requests the fixture; one way
to resolve this is to name the decorated function to resolve this is to name the decorated function
``fixture_<fixturename>`` and then use ``fixture_<fixturename>`` and then use
``@pytest.fixture(name='<fixturename>')``. ``@pytest.fixture(name='<fixturename>')``.
Fixtures can optionally provide their values to test functions using a ``yield`` statement, Fixtures can optionally provide their values to test functions using a ``yield`` statement,
instead of ``return``. In this case, the code block after the ``yield`` statement is executed instead of ``return``. In this case, the code block after the ``yield`` statement is executed