[py-svn] py-trunk commit 02f1d618996b: some doc fixes

commits-noreply at bitbucket.org commits-noreply at bitbucket.org
Thu Dec 24 13:14:11 CET 2009


# HG changeset patch -- Bitbucket.org
# Project py-trunk
# URL http://bitbucket.org/hpk42/py-trunk/overview/
# User holger krekel <holger at merlinux.eu>
# Date 1261038821 -3600
# Node ID 02f1d618996b91870c382e0e68f1a76efab345ba
# Parent 07fd4e3a6ac9cbc0d0f6c29bff84d17b6fa0a7f9
some doc fixes

--- a/doc/test/customize.txt
+++ b/doc/test/customize.txt
@@ -273,6 +273,8 @@ for example:
 
 When the test run finishes this corresponding finalizer hook is called:
 
+.. sourcecode:: python
+
     def pytest_unconfigure(config): 
         ... 
 
@@ -281,7 +283,9 @@ adding global py.test helpers and functi
 --------------------------------------------------------------------
 
 If you want to make global helper functions or objects available 
-to your test code you can implement: 
+to your test code you can implement:
+
+.. sourcecode:: python
 
     def pytest_namespace():
         """ return dictionary with items to be made available on py.test. namespace """

--- a/doc/test/plugin/hookspec.txt
+++ b/doc/test/plugin/hookspec.txt
@@ -62,7 +62,7 @@ hook specification sourcecode
     pytest_pycollect_makeitem.firstresult = True
     
     def pytest_pyfunc_call(pyfuncitem):
-        """ perform function call to the with the given function arguments. """ 
+        """ call underlying test function. """
     pytest_pyfunc_call.firstresult = True
     
     def pytest_generate_tests(metafunc):
@@ -73,7 +73,7 @@ hook specification sourcecode
     # -------------------------------------------------------------------------
     
     def pytest_runtest_protocol(item):
-        """ implement fixture, run and report protocol. """
+        """ implement fixture, run and report about the given test item. """
     pytest_runtest_protocol.firstresult = True
     
     def pytest_runtest_setup(item):
@@ -86,7 +86,7 @@ hook specification sourcecode
         """ called after pytest_runtest_call(). """ 
     
     def pytest_runtest_makereport(item, call):
-        """ make ItemTestReport for the given item and call outcome. """ 
+        """ make a test report for the given item and call outcome. """
     pytest_runtest_makereport.firstresult = True
     
     def pytest_runtest_logreport(report):

--- a/py/plugin/hookspec.py
+++ b/py/plugin/hookspec.py
@@ -56,7 +56,7 @@ def pytest_pycollect_makeitem(collector,
 pytest_pycollect_makeitem.firstresult = True
 
 def pytest_pyfunc_call(pyfuncitem):
-    """ perform function call to the with the given function arguments. """ 
+    """ call underlying test function. """
 pytest_pyfunc_call.firstresult = True
 
 def pytest_generate_tests(metafunc):
@@ -67,7 +67,7 @@ def pytest_generate_tests(metafunc):
 # -------------------------------------------------------------------------
 
 def pytest_runtest_protocol(item):
-    """ implement fixture, run and report protocol. """
+    """ implement fixture, run and report about the given test item. """
 pytest_runtest_protocol.firstresult = True
 
 def pytest_runtest_setup(item):
@@ -80,7 +80,7 @@ def pytest_runtest_teardown(item):
     """ called after pytest_runtest_call(). """ 
 
 def pytest_runtest_makereport(item, call):
-    """ make ItemTestReport for the given item and call outcome. """ 
+    """ make a test report for the given item and call outcome. """
 pytest_runtest_makereport.firstresult = True
 
 def pytest_runtest_logreport(report):



More information about the pytest-commit mailing list