summaryrefslogtreecommitdiffstats
path: root/Doc/library/unittest.rst
diff options
context:
space:
mode:
authorMark Dickinson <dickinsm@gmail.com>2009-02-01 14:18:10 (GMT)
committerMark Dickinson <dickinsm@gmail.com>2009-02-01 14:18:10 (GMT)
commitc48d83402687c0c5d6da1c7bb1a677208effa35e (patch)
tree3bc0e90855d9d77d2355e0e477c354d765db12b0 /Doc/library/unittest.rst
parentc008a176afdef8cb7afc0e48a8fb306f986964e8 (diff)
downloadcpython-c48d83402687c0c5d6da1c7bb1a677208effa35e.zip
cpython-c48d83402687c0c5d6da1c7bb1a677208effa35e.tar.gz
cpython-c48d83402687c0c5d6da1c7bb1a677208effa35e.tar.bz2
Issue #1717: documentation fixes related to the cmp removal.
Diffstat (limited to 'Doc/library/unittest.rst')
-rw-r--r--Doc/library/unittest.rst15
1 files changed, 10 insertions, 5 deletions
diff --git a/Doc/library/unittest.rst b/Doc/library/unittest.rst
index 8c078bc..29a5fd2 100644
--- a/Doc/library/unittest.rst
+++ b/Doc/library/unittest.rst
@@ -327,8 +327,9 @@ will create a test suite that will run ``WidgetTestCase.testDefaultSize()`` and
``WidgetTestCase.testResize``. :class:`TestLoader` uses the ``'test'`` method
name prefix to identify test methods automatically.
-Note that the order in which the various test cases will be run is determined by
-sorting the test function names with the built-in :func:`cmp` function.
+Note that the order in which the various test cases will be run is
+determined by sorting the test function names with respect to the
+built-in ordering for strings.
Often it is desirable to group suites of test cases together, so as to run tests
for the whole system at once. This is easy, since :class:`TestSuite` instances
@@ -921,9 +922,13 @@ subclassing or assignment on an instance:
.. attribute:: TestLoader.sortTestMethodsUsing
Function to be used to compare method names when sorting them in
- :meth:`getTestCaseNames` and all the :meth:`loadTestsFrom\*` methods. The
- default value is the built-in :func:`cmp` function; the attribute can also be
- set to :const:`None` to disable the sort.
+ :meth:`getTestCaseNames` and all the :meth:`loadTestsFrom\*`
+ methods. This should be a function that takes two arguments
+ ``self`` and ``other``, and returns ``-1`` if ``self`` precedes
+ ``other`` in the desired ordering, ``1`` if ``other`` precedes
+ ``self``, and ``0`` if ``self`` and ``other`` are equal. The
+ default ordering is the built-in ordering for strings. This
+ attribute can also be set to :const:`None` to disable the sort.
.. attribute:: TestLoader.suiteClass