docs: improve

n0-computer · Jun 30, 2023 · 08c9154 · 08c9154
1 parent 00f5539
commit 08c9154
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/iroh-net/src/magic_endpoint.rs b/iroh-net/src/magic_endpoint.rs
@@ -300,8 +300,8 @@ impl MagicEndpoint {
 
     /// Inform the magic socket about addresses of the peer.
     ///
-    /// The magic socket will try to connect to these addresses, and if successfull,
-    /// prefer them over talking to the peer over the DERP relay.
+    /// This updates the magic socket's *netmap* with these addresses, which are used as candidates
+    /// when connecting to this peer (in addition to addresses obtained from a derp server).
     pub async fn add_known_addrs(
         &self,
         peer_id: PeerId,