Merge pull request #2098 from DuncanBetts/master

Improved description of functionality for Issue #687
pytest-dev · Nov 29, 2016 · 8208a77 · 8208a77
2 parents 8b4da9d + 6473c3d
commit 8208a77
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -6,6 +6,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.
 
@@ -34,6 +36,7 @@
 
 .. _#2089: https://github.com/pytest-dev/pytest/issues/2089
 .. _#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

diff --git a/doc/en/fixture.rst b/doc/en/fixture.rst
@@ -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.