[mq]: 101doc

--HG--
branch : 1.0.x

doc/test/plugin/capture.txt

@@ -120,12 +120,10 @@ Start improving this plugin in 30 seconds
 =========================================
 
 
-Do you find the above documentation or the plugin itself lacking? 
-
 1. Download `pytest_capture.py`_ plugin source code 
 2. put it somewhere as ``pytest_capture.py`` into your import path 
 3. a subsequent ``py.test`` run will use your local version
 
-Further information: extend_ documentation, other plugins_ or contact_.  
+Checkout customize_, other plugins_ or `get in contact`_. 
 
 .. include:: links.txt

doc/test/plugin/doctest.txt

@@ -29,12 +29,10 @@ Start improving this plugin in 30 seconds
 =========================================
 
 
-Do you find the above documentation or the plugin itself lacking? 
-
 1. Download `pytest_doctest.py`_ plugin source code 
 2. put it somewhere as ``pytest_doctest.py`` into your import path 
 3. a subsequent ``py.test`` run will use your local version
 
-Further information: extend_ documentation, other plugins_ or contact_.  
+Checkout customize_, other plugins_ or `get in contact`_. 
 
 .. include:: links.txt

doc/test/plugin/figleaf.txt

@@ -24,12 +24,10 @@ Start improving this plugin in 30 seconds
 =========================================
 
 
-Do you find the above documentation or the plugin itself lacking? 
-
 1. Download `pytest_figleaf.py`_ plugin source code 
 2. put it somewhere as ``pytest_figleaf.py`` into your import path 
 3. a subsequent ``py.test`` run will use your local version
 
-Further information: extend_ documentation, other plugins_ or contact_.  
+Checkout customize_, other plugins_ or `get in contact`_. 
 
 .. include:: links.txt

doc/test/plugin/hooklog.txt

@@ -20,12 +20,10 @@ Start improving this plugin in 30 seconds
 =========================================
 
 
-Do you find the above documentation or the plugin itself lacking? 
-
 1. Download `pytest_hooklog.py`_ plugin source code 
 2. put it somewhere as ``pytest_hooklog.py`` into your import path 
 3. a subsequent ``py.test`` run will use your local version
 
-Further information: extend_ documentation, other plugins_ or contact_.  
+Checkout customize_, other plugins_ or `get in contact`_. 
 
 .. include:: links.txt

doc/test/plugin/hookspec.txt

@@ -97,7 +97,7 @@ hook specification sourcecode
         """ called before test session finishes. """
     pytest__teardown_final.firstresult = True
     
-    def pytest__teardown_final_logerror(rep):
+    def pytest__teardown_final_logerror(report):
         """ called if runtest_teardown_final failed. """ 
     
     # -------------------------------------------------------------------------
@@ -114,8 +114,8 @@ hook specification sourcecode
     # hooks for influencing reporting (invoked from pytest_terminal)
     # -------------------------------------------------------------------------
     
-    def pytest_report_teststatus(rep):
-        """ return shortletter and verbose word. """
+    def pytest_report_teststatus(report):
+        """ return result-category, shortletter and verbose word for reporting."""
     pytest_report_teststatus.firstresult = True
     
     def pytest_terminal_summary(terminalreporter):

doc/test/plugin/index.txt

@@ -16,11 +16,13 @@ recwarn_ helpers for asserting deprecation and other warnings.
 Plugins for other testing styles and languages
 ==============================================
 
+oejskit_ run javascript tests in real life browsers
+
 unittest_ automatically discover and run traditional "unittest.py" style tests.
 
-doctest_ collect and execute doctests from modules and test files.
+nose_ nose-compatibility plugin: allow to run nose test suites natively.
 
-oejskit_ run javascript tests in real life browsers
+doctest_ collect and execute doctests from modules and test files.
 
 restdoc_ perform ReST syntax, local and remote reference tests on .rst/.txt files.
 

doc/test/plugin/keyword.txt

@@ -35,12 +35,10 @@ Start improving this plugin in 30 seconds
 =========================================
 
 
-Do you find the above documentation or the plugin itself lacking? 
-
 1. Download `pytest_keyword.py`_ plugin source code 
 2. put it somewhere as ``pytest_keyword.py`` into your import path 
 3. a subsequent ``py.test`` run will use your local version
 
-Further information: extend_ documentation, other plugins_ or contact_.  
+Checkout customize_, other plugins_ or `get in contact`_. 
 
 .. include:: links.txt

doc/test/plugin/links.txt

@@ -1,33 +1,35 @@
 .. _`terminal`: terminal.html
-.. _`pytest_recwarn.py`: http://bitbucket.org/hpk42/py-trunk/raw/caf81a2cdf5083be3bfb715d7e56273330a54843/py/test/plugin/pytest_recwarn.py
+.. _`pytest_recwarn.py`: http://bitbucket.org/hpk42/py-trunk/raw/1.0.1/py/test/plugin/pytest_recwarn.py
 .. _`unittest`: unittest.html
-.. _`pytest_monkeypatch.py`: http://bitbucket.org/hpk42/py-trunk/raw/caf81a2cdf5083be3bfb715d7e56273330a54843/py/test/plugin/pytest_monkeypatch.py
-.. _`pytest_keyword.py`: http://bitbucket.org/hpk42/py-trunk/raw/caf81a2cdf5083be3bfb715d7e56273330a54843/py/test/plugin/pytest_keyword.py
+.. _`pytest_monkeypatch.py`: http://bitbucket.org/hpk42/py-trunk/raw/1.0.1/py/test/plugin/pytest_monkeypatch.py
+.. _`pytest_keyword.py`: http://bitbucket.org/hpk42/py-trunk/raw/1.0.1/py/test/plugin/pytest_keyword.py
 .. _`pastebin`: pastebin.html
 .. _`plugins`: index.html
-.. _`pytest_capture.py`: http://bitbucket.org/hpk42/py-trunk/raw/caf81a2cdf5083be3bfb715d7e56273330a54843/py/test/plugin/pytest_capture.py
-.. _`pytest_doctest.py`: http://bitbucket.org/hpk42/py-trunk/raw/caf81a2cdf5083be3bfb715d7e56273330a54843/py/test/plugin/pytest_doctest.py
+.. _`pytest_capture.py`: http://bitbucket.org/hpk42/py-trunk/raw/1.0.1/py/test/plugin/pytest_capture.py
+.. _`pytest_doctest.py`: http://bitbucket.org/hpk42/py-trunk/raw/1.0.1/py/test/plugin/pytest_doctest.py
 .. _`capture`: capture.html
-.. _`hooklog`: hooklog.html
-.. _`pytest_restdoc.py`: http://bitbucket.org/hpk42/py-trunk/raw/caf81a2cdf5083be3bfb715d7e56273330a54843/py/test/plugin/pytest_restdoc.py
-.. _`pytest_hooklog.py`: http://bitbucket.org/hpk42/py-trunk/raw/caf81a2cdf5083be3bfb715d7e56273330a54843/py/test/plugin/pytest_hooklog.py
-.. _`pytest_pastebin.py`: http://bitbucket.org/hpk42/py-trunk/raw/caf81a2cdf5083be3bfb715d7e56273330a54843/py/test/plugin/pytest_pastebin.py
-.. _`pytest_figleaf.py`: http://bitbucket.org/hpk42/py-trunk/raw/caf81a2cdf5083be3bfb715d7e56273330a54843/py/test/plugin/pytest_figleaf.py
+.. _`pytest_nose.py`: http://bitbucket.org/hpk42/py-trunk/raw/1.0.1/py/test/plugin/pytest_nose.py
+.. _`pytest_restdoc.py`: http://bitbucket.org/hpk42/py-trunk/raw/1.0.1/py/test/plugin/pytest_restdoc.py
 .. _`xfail`: xfail.html
-.. _`contact`: ../../contact.html
+.. _`pytest_pastebin.py`: http://bitbucket.org/hpk42/py-trunk/raw/1.0.1/py/test/plugin/pytest_pastebin.py
+.. _`pytest_figleaf.py`: http://bitbucket.org/hpk42/py-trunk/raw/1.0.1/py/test/plugin/pytest_figleaf.py
+.. _`pytest_hooklog.py`: http://bitbucket.org/hpk42/py-trunk/raw/1.0.1/py/test/plugin/pytest_hooklog.py
 .. _`checkout the py.test development version`: ../../download.html#checkout
 .. _`oejskit`: oejskit.html
-.. _`pytest_xfail.py`: http://bitbucket.org/hpk42/py-trunk/raw/caf81a2cdf5083be3bfb715d7e56273330a54843/py/test/plugin/pytest_xfail.py
+.. _`doctest`: doctest.html
+.. _`get in contact`: ../../contact.html
+.. _`pytest_xfail.py`: http://bitbucket.org/hpk42/py-trunk/raw/1.0.1/py/test/plugin/pytest_xfail.py
 .. _`figleaf`: figleaf.html
-.. _`extend`: ../extend.html
-.. _`pytest_terminal.py`: http://bitbucket.org/hpk42/py-trunk/raw/caf81a2cdf5083be3bfb715d7e56273330a54843/py/test/plugin/pytest_terminal.py
+.. _`customize`: ../customize.html
+.. _`hooklog`: hooklog.html
+.. _`pytest_terminal.py`: http://bitbucket.org/hpk42/py-trunk/raw/1.0.1/py/test/plugin/pytest_terminal.py
 .. _`recwarn`: recwarn.html
-.. _`pytest_pdb.py`: http://bitbucket.org/hpk42/py-trunk/raw/caf81a2cdf5083be3bfb715d7e56273330a54843/py/test/plugin/pytest_pdb.py
+.. _`pytest_pdb.py`: http://bitbucket.org/hpk42/py-trunk/raw/1.0.1/py/test/plugin/pytest_pdb.py
 .. _`monkeypatch`: monkeypatch.html
 .. _`resultlog`: resultlog.html
 .. _`keyword`: keyword.html
 .. _`restdoc`: restdoc.html
-.. _`pytest_unittest.py`: http://bitbucket.org/hpk42/py-trunk/raw/caf81a2cdf5083be3bfb715d7e56273330a54843/py/test/plugin/pytest_unittest.py
-.. _`doctest`: doctest.html
-.. _`pytest_resultlog.py`: http://bitbucket.org/hpk42/py-trunk/raw/caf81a2cdf5083be3bfb715d7e56273330a54843/py/test/plugin/pytest_resultlog.py
+.. _`pytest_unittest.py`: http://bitbucket.org/hpk42/py-trunk/raw/1.0.1/py/test/plugin/pytest_unittest.py
+.. _`nose`: nose.html
+.. _`pytest_resultlog.py`: http://bitbucket.org/hpk42/py-trunk/raw/1.0.1/py/test/plugin/pytest_resultlog.py
 .. _`pdb`: pdb.html

doc/test/plugin/monkeypatch.txt

@@ -10,7 +10,7 @@ safely patch object attributes, dicts and environment variables.
 Usage
 ----------------
 
-Use the `monkeypatch funcarg`_ to safely patch the environment
+Use the `monkeypatch funcarg`_ to safely patch environment
 variables, object attributes or dictionaries.  For example, if you want
 to set the environment variable ``ENV1`` and patch the
 ``os.path.abspath`` function to return a particular value during a test
@@ -26,7 +26,16 @@ function execution you can write it down like this:
 The function argument will do the modifications and memorize the 
 old state.  After the test function finished execution all 
 modifications will be reverted.  See the `monkeypatch blog post`_ 
-for an extensive discussion. 
+for an extensive discussion.  
+
+To add to a possibly existing environment parameter you
+can use this example: 
+
+.. sourcecode:: python 
+
+    def test_mypath_finding(monkeypatch):
+        monkeypatch.setenv('PATH', 'x/y', prepend=":")
+        #  x/y will be at the beginning of $PATH 
 
 .. _`monkeypatch blog post`: http://tetamap.wordpress.com/2009/03/03/monkeypatching-in-unit-tests-done-right/
 
@@ -50,12 +59,10 @@ Start improving this plugin in 30 seconds
 =========================================
 
 
-Do you find the above documentation or the plugin itself lacking? 
-
 1. Download `pytest_monkeypatch.py`_ plugin source code 
 2. put it somewhere as ``pytest_monkeypatch.py`` into your import path 
 3. a subsequent ``py.test`` run will use your local version
 
-Further information: extend_ documentation, other plugins_ or contact_.  
+Checkout customize_, other plugins_ or `get in contact`_. 
 
 .. include:: links.txt

doc/test/plugin/nose.txt

@@ -53,12 +53,10 @@ Start improving this plugin in 30 seconds
 =========================================
 
 
-Do you find the above documentation or the plugin itself lacking? 
-
 1. Download `pytest_nose.py`_ plugin source code 
 2. put it somewhere as ``pytest_nose.py`` into your import path 
 3. a subsequent ``py.test`` run will use your local version
 
-Further information: extend_ documentation, other plugins_ or contact_.  
+Checkout customize_, other plugins_ or `get in contact`_. 
 
 .. include:: links.txt

doc/test/plugin/pastebin.txt

@@ -14,7 +14,7 @@ Usage
 
     py.test --pastebin=failed 
 
-This will submit full failure information to a remote Paste service and
+This will submit test run information to a remote Paste service and
 provide a URL for each failure.  You may select tests as usual or add
 for example ``-x`` if you only want to send one particular failure. 
 
@@ -35,12 +35,10 @@ Start improving this plugin in 30 seconds
 =========================================
 
 
-Do you find the above documentation or the plugin itself lacking? 
-
 1. Download `pytest_pastebin.py`_ plugin source code 
 2. put it somewhere as ``pytest_pastebin.py`` into your import path 
 3. a subsequent ``py.test`` run will use your local version
 
-Further information: extend_ documentation, other plugins_ or contact_.  
+Checkout customize_, other plugins_ or `get in contact`_. 
 
 .. include:: links.txt

doc/test/plugin/pdb.txt

@@ -20,12 +20,10 @@ Start improving this plugin in 30 seconds
 =========================================
 
 
-Do you find the above documentation or the plugin itself lacking? 
-
 1. Download `pytest_pdb.py`_ plugin source code 
 2. put it somewhere as ``pytest_pdb.py`` into your import path 
 3. a subsequent ``py.test`` run will use your local version
 
-Further information: extend_ documentation, other plugins_ or contact_.  
+Checkout customize_, other plugins_ or `get in contact`_. 
 
 .. include:: links.txt

doc/test/plugin/recwarn.txt

@@ -50,12 +50,10 @@ Start improving this plugin in 30 seconds
 =========================================
 
 
-Do you find the above documentation or the plugin itself lacking? 
-
 1. Download `pytest_recwarn.py`_ plugin source code 
 2. put it somewhere as ``pytest_recwarn.py`` into your import path 
 3. a subsequent ``py.test`` run will use your local version
 
-Further information: extend_ documentation, other plugins_ or contact_.  
+Checkout customize_, other plugins_ or `get in contact`_. 
 
 .. include:: links.txt

doc/test/plugin/restdoc.txt

@@ -24,12 +24,10 @@ Start improving this plugin in 30 seconds
 =========================================
 
 
-Do you find the above documentation or the plugin itself lacking? 
-
 1. Download `pytest_restdoc.py`_ plugin source code 
 2. put it somewhere as ``pytest_restdoc.py`` into your import path 
 3. a subsequent ``py.test`` run will use your local version
 
-Further information: extend_ documentation, other plugins_ or contact_.  
+Checkout customize_, other plugins_ or `get in contact`_. 
 
 .. include:: links.txt

doc/test/plugin/resultlog.txt

@@ -20,12 +20,10 @@ Start improving this plugin in 30 seconds
 =========================================
 
 
-Do you find the above documentation or the plugin itself lacking? 
-
 1. Download `pytest_resultlog.py`_ plugin source code 
 2. put it somewhere as ``pytest_resultlog.py`` into your import path 
 3. a subsequent ``py.test`` run will use your local version
 
-Further information: extend_ documentation, other plugins_ or contact_.  
+Checkout customize_, other plugins_ or `get in contact`_. 
 
 .. include:: links.txt

doc/test/plugin/terminal.txt

@@ -28,12 +28,10 @@ Start improving this plugin in 30 seconds
 =========================================
 
 
-Do you find the above documentation or the plugin itself lacking? 
-
 1. Download `pytest_terminal.py`_ plugin source code 
 2. put it somewhere as ``pytest_terminal.py`` into your import path 
 3. a subsequent ``py.test`` run will use your local version
 
-Further information: extend_ documentation, other plugins_ or contact_.  
+Checkout customize_, other plugins_ or `get in contact`_. 
 
 .. include:: links.txt

doc/test/plugin/unittest.txt

@@ -23,12 +23,10 @@ Start improving this plugin in 30 seconds
 =========================================
 
 
-Do you find the above documentation or the plugin itself lacking? 
-
 1. Download `pytest_unittest.py`_ plugin source code 
 2. put it somewhere as ``pytest_unittest.py`` into your import path 
 3. a subsequent ``py.test`` run will use your local version
 
-Further information: extend_ documentation, other plugins_ or contact_.  
+Checkout customize_, other plugins_ or `get in contact`_. 
 
 .. include:: links.txt

doc/test/plugin/xfail.txt

@@ -25,12 +25,10 @@ Start improving this plugin in 30 seconds
 =========================================
 
 
-Do you find the above documentation or the plugin itself lacking? 
-
 1. Download `pytest_xfail.py`_ plugin source code 
 2. put it somewhere as ``pytest_xfail.py`` into your import path 
 3. a subsequent ``py.test`` run will use your local version
 
-Further information: extend_ documentation, other plugins_ or contact_.  
+Checkout customize_, other plugins_ or `get in contact`_. 
 
 .. include:: links.txt