summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorMichael Foord <fuzzyman@voidspace.org.uk>2010-04-05 10:26:26 (GMT)
committerMichael Foord <fuzzyman@voidspace.org.uk>2010-04-05 10:26:26 (GMT)
commit3165503b4a0f1215d5d4750cc659dabaf08ef14d (patch)
treef314eaca24968537c4e490e2267efe2e0acec7cb /Doc
parent9ccc58113e805a3def5ca4c3cf0bd620c92fafde (diff)
downloadcpython-3165503b4a0f1215d5d4750cc659dabaf08ef14d.zip
cpython-3165503b4a0f1215d5d4750cc659dabaf08ef14d.tar.gz
cpython-3165503b4a0f1215d5d4750cc659dabaf08ef14d.tar.bz2
Documentation fixes for unittest
Diffstat (limited to 'Doc')
-rw-r--r--Doc/library/unittest.rst15
1 files changed, 8 insertions, 7 deletions
diff --git a/Doc/library/unittest.rst b/Doc/library/unittest.rst
index 715c485..c1a11a6 100644
--- a/Doc/library/unittest.rst
+++ b/Doc/library/unittest.rst
@@ -229,8 +229,8 @@ unittest supports three command options.
* -c / --catch
- Control-C during the test run waits for the current test to end and then
- reports all the results so far. A second control-C raises the normal
+ Control-c during the test run waits for the current test to end and then
+ reports all the results so far. A second control-c raises the normal
``KeyboardInterrupt`` exception.
See `Signal Handling`_ for the functions that provide this functionality.
@@ -1858,18 +1858,19 @@ functionality within test frameworks.
.. function:: installHandler()
- Install the control-C handler. When a :const:`signal.SIGINT` is received
- (usually in response to the user pressing control-C) all registered results
+ Install the control-c handler. When a :const:`signal.SIGINT` is received
+ (usually in response to the user pressing control-c) all registered results
have :meth:`~TestResult.stop` called.
.. function:: registerResult(result)
- Register a :class:`TestResult` object for control-C handling. Registering a
+ Register a :class:`TestResult` object for control-c handling. Registering a
result stores a weak reference to it, so it doesn't prevent the result from
being garbage collected.
.. function:: removeResult(result)
- Remove a registered result. One a result has been removed then ``stop`` will
- no longer be called on that result object in response to a control-C.
+ Remove a registered result. Once a result has been removed then
+ :meth:`~Testresult.stop`` will no longer be called on that result object in
+ response to a control-c.