Add a comment.

matrix-org · Jul 20, 2022 · edab4ec · edab4ec
1 parent 9f1dfa5
commit edab4ec
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/tests/logging/test_opentracing.py b/tests/logging/test_opentracing.py
@@ -42,6 +42,14 @@
 
 
 class LogContextScopeManagerTestCase(TestCase):
+    """
+    Test logging contexts and active opentracing spans.
+
+    There's casts throughout this from generic opentracing objects (e.g.
+    opentracing.Span) to the ones specific to Jaeger since they have additional
+    properties that these tests depend on. This is safe since the only supported
+    opentracing backend is Jaeger.
+    """
     if LogContextScopeManager is None:
         skip = "Requires opentracing"  # type: ignore[unreachable]
     if jaeger_client is None: