[Python-checkins] cpython: Closes issue 20031. Document unittest.TextTestRunner.run method.

[michael.foord]

http://hg.python.org/cpython/rev/19464d77ec2e
changeset:   88223:19464d77ec2e
user:        Michael Foord <michael at voidspace.org.uk>
date:        Sun Dec 29 23:38:55 2013 +0000
summary:
  Closes issue 20031. Document unittest.TextTestRunner.run method.

files:
  Doc/library/unittest.rst |  8 ++++++++
  1 files changed, 8 insertions(+), 0 deletions(-)


diff --git a/Doc/library/unittest.rst b/Doc/library/unittest.rst
--- a/Doc/library/unittest.rst
+++ b/Doc/library/unittest.rst
@@ -1939,6 +1939,14 @@
 
         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, \

-- 
Repository URL: http://hg.python.org/cpython