test_support: add a docstring to vereq().

tim-one · tim-one · commit 77902970c598 · 2001-12-29T17:34:57.000Z
test_complex:  repair new test's usage of vereq().
diff --git a/Lib/test/test_complex.py b/Lib/test/test_complex.py
@@ -63,8 +63,7 @@ def test_div(x, y):
 if complex(0.0, 0.0):
     raise TestFailed("complex(0.0, 0.0) should be false")
 
-if vereq(complex(5.3, 9.8).conjugate(), 5.3-9.8j):
-    raise TestFailed("complex.conjugate() didn't work")
+vereq(complex(5.3, 9.8).conjugate(), 5.3-9.8j)
 
 try:
     print int(5+3j)
diff --git a/Lib/test/test_support.py b/Lib/test/test_support.py
@@ -118,6 +118,16 @@ def verify(condition, reason='test failed'):
         raise TestFailed(reason)
 
 def vereq(a, b):
+    """Raise TestFailed if a == b is false.
+
+    This is better than verify(a == b) because, in case of failure, the
+    error message incorporates repr(a) and repr(b) so you can see the
+    inputs.
+
+    Note that "not (a == b)" isn't necessarily the same as "a != b"; the
+    former is tested.
+    """
+
     if not (a == b):
         raise TestFailed, "%r == %r" % (a, b)
 
