Update src/twisted/test/test_defer.py

graingert · adiroiban · web-flow · commit 2df4c76a41e8 · 2023-10-16T10:34:14.000+01:00
Co-authored-by: Adi Roiban &lt;adiroiban@gmail.com&gt;
diff --git a/src/twisted/test/test_defer.py b/src/twisted/test/test_defer.py
@@ -1714,7 +1714,15 @@ def test_inlineCallbacksTracebacks(self) -> None:
         except BaseException:
             d.errback()
 
-        def ic(d: object) -> Generator[Any, Any, None]:
+        def ic(d: object) -> Generator[Any, Any, None]:  # pragma: no cover
+            """
+            This is never called.
+            It is only used as the decorated function.
+            The resulting function is never called in this test.
+            This is used to make sure that if we wrap
+            an already failed deferred, inlineCallbacks
+            will not add any extra traceback frames. 
+            """
             yield d
 
         defer.inlineCallbacks(ic)
