itsscb/tracing
1
0
Fork 0
mirror of https://github.com/tokio-rs/tracing.git synced 2025-10-05 00:34:44 +00:00
Code Issues Packages Projects Releases Wiki Activity

core: update parent() documentation (#1665)

Browse Source 
`Event::parent()` and `Span::parent()` returns an `Option`, not boolean.
This commit is contained in:
Markus Bergkvist 2021-10-21 19:11:41 +02:00 committed by Eliza Weisman
parent f5aac47f68
commit d019e43540
2 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
tracing-core/src/event.rs
View File

@ -118,7 +118,7 @@ impl<'a> Event<'a> {
/// Returns the new event's explicitly-specified parent, if there is one. /// 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), /// 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> { pub fn parent(&self) -> Option<&Id> {
match self.parent { match self.parent {
Parent::Explicit(ref p) => Some(p), Parent::Explicit(ref p) => Some(p),

2
tracing-core/src/span.rs
View File

@ -168,7 +168,7 @@ impl<'a> Attributes<'a> {
/// Returns the new span's explicitly-specified parent, if there is one. /// 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), /// 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> { pub fn parent(&self) -> Option<&Id> {
match self.parent { match self.parent {
Parent::Explicit(ref p) => Some(p), Parent::Explicit(ref p) => Some(p),