clarify Ancestry options in the enum

tokio-rs · Aug 5, 2024 · dbdf5f0 · dbdf5f0
1 parent 3cb2c16
commit dbdf5f0
Showing 1 changed file with 7 additions and 4 deletions.
diff --git a/tracing-mock/src/ancestry.rs b/tracing-mock/src/ancestry.rs
@@ -20,11 +20,14 @@ pub enum Ancestry {
     /// The event or span is an explicitly defined root. It was created with `parent: None` and
     /// has no parent.
     IsExplicitRoot,
-    /// The event or span has a contextually assigned parent with the specified name. Additionally,
-    /// it has no explicitly assigned parent.
+    /// The event or span has a contextually assigned parent with the specified name. It has no
+    /// explicitly assigned parent, nor has it been explicitly defined as a root (it was created
+    /// without the `parent:` directive). There was a span in context when this event or span was
+    /// created.
     HasContextualParent(String),
-    /// The event or span is a contextual root. It has no contextual parent and also has no
-    /// explicitly assigned parent.
+    /// The event or span is a contextual root. It has no explicitly assigned parent, nor has it
+    /// been explicitly defined as a root (it was created without the `parent:` directive).
+    /// Additionally, no span was in context when this event or span was created.
     IsContextualRoot,
 }