defer: Add a note of why tests should call certain functions directly

twisted · May 16, 2024 · 8a588fa · 8a588fa
1 parent 0bfd831
commit 8a588fa
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/src/twisted/internet/test/test_inlinecb.py b/src/twisted/internet/test/test_inlinecb.py
@@ -54,6 +54,11 @@ class BasicTests(TestCase):
     """
     This test suite tests basic use cases of L{inlineCallbacks}. For more
     complex tests see e.g. StackedInlineCallbacksTests.
+
+    Note that it is important to directly call addCallbacks and other
+    functions exposed as an API, because both L{inlineCallbacks} and
+    L{Deferred} may be optimized in ways that are only exercised in particular
+    situations.
     """
 
     def testBasics(self):