Skip to content

Commit

Permalink
Improved description of functionality for Issue pytest-dev#687
Browse files Browse the repository at this point in the history
  • Loading branch information
Duncan Betts committed Nov 28, 2016
1 parent 0735d45 commit 6473c3d
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 2 deletions.
3 changes: 3 additions & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@

* Add hint to error message hinting possible missing ``__init__.py`` (`#478`_). Thanks `@DuncanBetts`_.

* More accurately describe when fixture finalization occurs in documentation (`#687`_). Thanks `@DuncanBetts`_.

* Provide ``:ref:`` targets for ``recwarn.rst`` so we can use intersphinx referencing.
Thanks to `@dupuy`_ for the report and `@lwm`_ for the PR.

Expand Down Expand Up @@ -34,6 +36,7 @@
.. _@nmundar: https://github.com/nmundar

.. _#478: https://github.com/pytest-dev/pytest/issues/478
.. _#687: https://github.com/pytest-dev/pytest/issues/687
.. _#2034: https://github.com/pytest-dev/pytest/issues/2034
.. _#2038: https://github.com/pytest-dev/pytest/issues/2038
.. _#2078: https://github.com/pytest-dev/pytest/issues/2078
Expand Down
3 changes: 1 addition & 2 deletions doc/en/fixture.rst
Original file line number Diff line number Diff line change
Expand Up @@ -318,8 +318,7 @@ the ``with`` statement ends.
request.addfinalizer(fin)
return smtp # provide the fixture value

The ``fin`` function will execute when the last test using
the fixture in the module has finished execution.
The ``fin`` function will execute when the last test in the module has finished execution.

This method is still fully supported, but ``yield`` is recommended from 2.10 onward because
it is considered simpler and better describes the natural code flow.
Expand Down

0 comments on commit 6473c3d

Please sign in to comment.