Skip to content
This repository was archived by the owner on Oct 23, 2022. It is now read-only.

Commit 9e93444

Browse files
author
Joonas Koivunen
committed
doc: adjust IpfsOptions::span
1 parent f6ec5fa commit 9e93444

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

src/lib.rs

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -142,8 +142,11 @@ pub struct IpfsOptions {
142142
/// Bound listening addresses; by default the node will not listen on any address.
143143
pub listening_addrs: Vec<Multiaddr>,
144144

145-
/// The span for tracing purposes. All futures returned by `Ipfs`, background task actions and
146-
/// swarm actions are instrumented with this span or spans referring to this as their parent.
145+
/// The span for tracing purposes, `None` value is converted to `tracing::trace_span!("ipfs")`.
146+
///
147+
/// All futures returned by `Ipfs`, background task actions and swarm actions are instrumented
148+
/// with this span or spans referring to this as their parent. Setting this other than `None`
149+
/// default is useful when running multiple nodes.
147150
pub span: Option<Span>,
148151
}
149152

0 commit comments

Comments
 (0)