]> granicus.if.org Git - python/commitdiff
Closes issue 20031. Document unittest.TextTestRunner.run method.
authorMichael Foord <michael@voidspace.org.uk>
Sun, 29 Dec 2013 23:38:55 +0000 (23:38 +0000)
committerMichael Foord <michael@voidspace.org.uk>
Sun, 29 Dec 2013 23:38:55 +0000 (23:38 +0000)
Doc/library/unittest.rst

index 63106242129fa6e6a391124941d3a9efa489d99b..46d303ab63999a3f947be91f6668b5682d3d9b79 100644 (file)
@@ -1939,6 +1939,14 @@ Loading and running tests
 
         stream, descriptions, verbosity
 
+   .. method:: run(test)
+
+      This method is the main public interface to the `TextTestRunner`. This
+      method takes a :class:`TestSuite` or :class:`TestCase` instance. A
+      :class:`TestResult` is created by calling
+      :func:`_makeResult` and the test(s) are run and the
+      results printed to stdout.
+
 
 .. function:: main(module='__main__', defaultTest=None, argv=None, testRunner=None, \
                    testLoader=unittest.defaultTestLoader, exit=True, verbosity=1, \