swarm/src/lib: Update outdated SwarmEvent::Dialing comment (#2429)

Since https://github.com/libp2p/rust-libp2p/pull/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.
This commit is contained in:
Max Inden 2022-01-14 13:17:45 +01:00 committed by GitHub
parent c61ea6ad29
commit a2621ad498
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -236,12 +236,13 @@ pub enum SwarmEvent<TBehaviourOutEvent, THandlerErr> {
/// The listener error. /// The listener error.
error: io::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 /// A [`ConnectionEstablished`](SwarmEvent::ConnectionEstablished) event is
/// reported if the dialing attempt succeeds, otherwise a /// reported if the dialing attempt succeeds, otherwise a
/// [`OutgoingConnectionError`](SwarmEvent::OutgoingConnectionError) event /// [`OutgoingConnectionError`](SwarmEvent::OutgoingConnectionError) event
/// is reported with `attempts_remaining` equal to 0. /// is reported.
Dialing(PeerId), Dialing(PeerId),
} }