From f2df6fa3652362184187940089902ffaf748c01d Mon Sep 17 00:00:00 2001
From: santos227 <rn_santos227@outlook.com>
Date: Fri, 14 Jan 2022 13:17:45 +0100
Subject: [PATCH] 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.
---
 swarm/src/lib.rs | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/swarm/src/lib.rs b/swarm/src/lib.rs
index 97043240..cc09ebf2 100644
--- a/swarm/src/lib.rs
+++ b/swarm/src/lib.rs
@@ -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),
 }