Skip to content

Commit

Permalink
swarm/src/lib: Update outdated SwarmEvent::Dialing comment
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
mxinden committed Jan 12, 2022
1 parent 5617481 commit 842d25b
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions swarm/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -236,12 +236,13 @@ pub enum SwarmEvent<TBehaviourOutEvent, THandlerErr> {
/// The listener error.
error: io::Error,
},
/// A new dialing attempt has been initiated.
/// A new dialing attempt has been initiated by the [`NetworkBehaviour`]
/// implementation.
///
/// A [`ConnectionEstablished`](SwarmEvent::ConnectionEstablished) event is
/// reported if the dialing attempt succeeds, otherwise a
/// [`OutgoingConnectionError`](SwarmEvent::OutgoingConnectionError) event
/// is reported with `attempts_remaining` equal to 0.
/// is reported.
Dialing(PeerId),
}

Expand Down

0 comments on commit 842d25b

Please sign in to comment.