From: Michael Foord <michael@voidspace.org.uk>
Date: Sun, 29 Dec 2013 23:38:55 +0000 (+0000)
Subject: Closes issue 20031. Document unittest.TextTestRunner.run method.
X-Git-Tag: v3.4.0b2~70
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=4d1639f4e5513945ac84ea5dbd242da6bb0f6058;p=python

Closes issue 20031. Document unittest.TextTestRunner.run method.
---

diff --git a/Doc/library/unittest.rst b/Doc/library/unittest.rst
index 6310624212..46d303ab63 100644
--- a/Doc/library/unittest.rst
+++ b/Doc/library/unittest.rst
@@ -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, \