From 66fb1397390db71b62a58aef77911cf354ee597d Mon Sep 17 00:00:00 2001
From: Ned Batchelder <ned@nedbatchelder.com>
Date: Mon, 4 Jan 2016 09:31:55 -0500
Subject: Clarify when delayed_assertions is known to work.

---
 coverage/test_helpers.py | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

(limited to 'coverage/test_helpers.py')

diff --git a/coverage/test_helpers.py b/coverage/test_helpers.py
index 1d606aa..a76bed3 100644
--- a/coverage/test_helpers.py
+++ b/coverage/test_helpers.py
@@ -198,7 +198,11 @@ class DelayedAssertionMixin(TestCase):
     All of the assertions will run.  The failures will be displayed at the end
     of the with-statement.
 
-    NOTE: only works with some assert methods, I'm not sure which!
+    NOTE: this only works with some assertions.  These are known to work:
+
+        - `assertEqual(str, str)`
+
+        - `assertMultilineEqual(str, str)`
 
     """
     def __init__(self, *args, **kwargs):
-- 
cgit v1.2.1