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

586edab2 · Georg Brandl · 439f250c · 586edab2
Commit 586edab2 authored Nov 24, 2007 by Georg Brandl
Hide whitespace changes
Inline Side-by-side

Showing with 6 additions and 4 deletions

Doc/library/unittest.rst Doc/library/unittest.rst +6 -4

No files found.
--- 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``
+   The default implementation appends a tuple ``(test, formatted_err)`` to the
-   attribute.
+   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
+   The default implementation appends a tuple ``(test, formatted_err)`` to the
-   ``failures`` attribute.
+   instance's ``failures`` attribute, where *formatted_err* is a formatted
+   traceback derived from *err*.
 .. method:: TestResult.addSuccess(test)