docs: change advertisements to registration

vacp2p · Oct 1, 2024 · db2699b · db2699b
1 parent a6c5343
commit db2699b
Showing 1 changed file with 3 additions and 3 deletions.
diff --git a/libp2p/protocols/rendezvous.nim b/libp2p/protocols/rendezvous.nim
@@ -506,11 +506,11 @@ proc advertisePeer(rdv: RendezVous, peer: PeerId, msg: seq[byte]) {.async.} =
   discard await advertiseWrap().withTimeout(5.seconds)
 
 proc advertise*(
-    rdv: RendezVous, ns: string, ttl: Duration, peers: seq[PeerId]
+    rdv: RendezVous, ns: string, ttl: Duration = rdv.minDuration, peers: seq[PeerId]
 ) {.async.} =
-  ## The advertise async procedure sends advertisements for a namespace
+  ## The advertise async procedure sends a registration for a namespace
   ## to a sequence of peers. It encodes and sends a signed peer record
-  ## along with a time-to-live value. Advertisements are sent
+  ## along with a time-to-live value. The registrations are sent
   ## concurrently to all specified peers.
   ##
   if ns.len notin 1 .. 255: