Skip to content

Commit 842d25b

Browse files
committed
swarm/src/lib: Update outdated SwarmEvent::Dialing comment
Since libp2p#2248 dial attempts are no longer reported per address, but instead reported for all addresses of a single dial at once. This commit updates the comment accordingly.
1 parent 5617481 commit 842d25b

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

swarm/src/lib.rs

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -236,12 +236,13 @@ pub enum SwarmEvent<TBehaviourOutEvent, THandlerErr> {
236236
/// The listener error.
237237
error: io::Error,
238238
},
239-
/// A new dialing attempt has been initiated.
239+
/// A new dialing attempt has been initiated by the [`NetworkBehaviour`]
240+
/// implementation.
240241
///
241242
/// A [`ConnectionEstablished`](SwarmEvent::ConnectionEstablished) event is
242243
/// reported if the dialing attempt succeeds, otherwise a
243244
/// [`OutgoingConnectionError`](SwarmEvent::OutgoingConnectionError) event
244-
/// is reported with `attempts_remaining` equal to 0.
245+
/// is reported.
245246
Dialing(PeerId),
246247
}
247248

0 commit comments

Comments
 (0)