core: update parent() documentation (#1665)

`Event::parent()` and `Span::parent()` returns an `Option`, not boolean.
tokio-rs · Oct 22, 2021 · d019e43 · d019e43
1 parent f5aac47
commit d019e43
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/tracing-core/src/event.rs b/tracing-core/src/event.rs
@@ -118,7 +118,7 @@ impl<'a> Event<'a> {
     /// Returns the new event's explicitly-specified parent, if there is one.
     ///
     /// Otherwise (if the new event is a root or is a child of the current span),
-    /// returns false.
+    /// returns `None`.
     pub fn parent(&self) -> Option<&Id> {
         match self.parent {
             Parent::Explicit(ref p) => Some(p),

diff --git a/tracing-core/src/span.rs b/tracing-core/src/span.rs
@@ -168,7 +168,7 @@ impl<'a> Attributes<'a> {
     /// Returns the new span's explicitly-specified parent, if there is one.
     ///
     /// Otherwise (if the new span is a root or is a child of the current span),
-    /// returns false.
+    /// returns `None`.
     pub fn parent(&self) -> Option<&Id> {
         match self.parent {
             Parent::Explicit(ref p) => Some(p),