From: Georg Brandl <georg@python.org>
Date: Sat, 24 Nov 2007 11:39:13 +0000 (+0000)
Subject: #1467: fix documentation for TestResult.add{Error,Failure}.
X-Git-Tag: v2.6a1~1005
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=586edab2795f6926902c4fb8e378c0c704b9920e;p=python

#1467: fix documentation for TestResult.add{Error,Failure}.
---

diff --git a/Doc/library/unittest.rst b/Doc/library/unittest.rst
index 3d3727fe94..90d32e2047 100644
--- a/Doc/library/unittest.rst
+++ b/Doc/library/unittest.rst
@@ -814,8 +814,9 @@ tools which support interactive reporting while tests are being run.
    Called when the test case *test* raises an unexpected exception *err* is a tuple
    of the form returned by :func:`sys.exc_info`: ``(type, value, traceback)``.
 
-   The default implementation appends ``(test, err)`` to the instance's ``errors``
-   attribute.
+   The default implementation appends a tuple ``(test, formatted_err)`` to the
+   instance's ``errors`` attribute, where *formatted_err* is a formatted
+   traceback derived from *err*.
 
 
 .. method:: TestResult.addFailure(test, err)
@@ -823,8 +824,9 @@ tools which support interactive reporting while tests are being run.
    Called when the test case *test* signals a failure. *err* is a tuple of the form
    returned by :func:`sys.exc_info`:  ``(type, value, traceback)``.
 
-   The default implementation appends ``(test, err)`` to the instance's
-   ``failures`` attribute.
+   The default implementation appends a tuple ``(test, formatted_err)`` to the
+   instance's ``failures`` attribute, where *formatted_err* is a formatted
+   traceback derived from *err*.
 
 
 .. method:: TestResult.addSuccess(test)