From: Michael Foord <fuzzyman@voidspace.org.uk>
Date: Sat, 5 Jun 2010 21:59:55 +0000 (+0000)
Subject: Merged revisions 81767 via svnmerge from
X-Git-Tag: v3.2a1~623
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=98b3e7652b39bc889aa260abb38b6c7b1fadf9ab;p=python

Merged revisions 81767 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk

........
  r81767 | michael.foord | 2010-06-05 22:57:03 +0100 (Sat, 05 Jun 2010) | 1 line

  Documentation updates for issues 8302 and 8351 (truncating excessive diffs in unittest failure messages and reporting SkipTest exceptions in setUpClass and setUpModule as skips rather than errors).
........
---

diff --git a/Doc/library/unittest.rst b/Doc/library/unittest.rst
index 1cb4124d87..c36ff87e5b 100644
--- a/Doc/library/unittest.rst
+++ b/Doc/library/unittest.rst
@@ -1168,6 +1168,21 @@ Test cases
       .. versionadded:: 3.1
 
 
+   .. attribute:: maxDiff
+
+      This attribute controls the maximum length of diffs output by assert
+      methods that report diffs on failure. It defaults to 80*8 characters.
+      Assert methods affected by this attribute are
+      :meth:`assertSequenceEqual` (including all the sequence comparison
+      methods that delegate to it), :meth:`assertDictEqual` and
+      :meth:`assertMultiLineEqual`.
+
+      Setting ``maxDiff`` to None means that there is no maximum length of
+      diffs.
+
+      .. versionadded:: 3.2
+
+
    Testing frameworks can use the following methods to collect information on
    the test:
 
@@ -1862,7 +1877,9 @@ then you must call up to them yourself. The implementations in
 
 If an exception is raised during a ``setUpClass`` then the tests in the class
 are not run and the ``tearDownClass`` is not run. Skipped classes will not
-have ``setUpClass`` or ``tearDownClass`` run.
+have ``setUpClass`` or ``tearDownClass`` run. If the exception is a
+``SkipTest`` exception then the class will be reported as having been skipped
+instead of as an error.
 
 
 setUpModule and tearDownModule
@@ -1877,7 +1894,9 @@ These should be implemented as functions::
         closeConnection()
 
 If an exception is raised in a ``setUpModule`` then none of the tests in the
-module will be run and the ``tearDownModule`` will not be run.
+module will be run and the ``tearDownModule`` will not be run. If the exception is a
+``SkipTest`` exception then the module will be reported as having been skipped
+instead of as an error.
 
 
 Signal Handling