summaryrefslogtreecommitdiffstats
path: root/Doc/library/unittest.rst
diff options
context:
space:
mode:
authorMichael Foord <michael@voidspace.org.uk>2013-12-29 23:38:55 (GMT)
committerMichael Foord <michael@voidspace.org.uk>2013-12-29 23:38:55 (GMT)
commit4d1639f4e5513945ac84ea5dbd242da6bb0f6058 (patch)
tree9bbf56b2ebfcb42a2ca10ede951dc94e0a6bafaa /Doc/library/unittest.rst
parent2691ee61833f7f460b5f67795b232a9b6f4518d8 (diff)
downloadcpython-4d1639f4e5513945ac84ea5dbd242da6bb0f6058.zip
cpython-4d1639f4e5513945ac84ea5dbd242da6bb0f6058.tar.gz
cpython-4d1639f4e5513945ac84ea5dbd242da6bb0f6058.tar.bz2
Closes issue 20031. Document unittest.TextTestRunner.run method.
Diffstat (limited to 'Doc/library/unittest.rst')
-rw-r--r--Doc/library/unittest.rst8
1 files changed, 8 insertions, 0 deletions
diff --git a/Doc/library/unittest.rst b/Doc/library/unittest.rst
index 6310624..46d303a 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, \