Skip to content

Commit e4549e5

Browse files
committed
docs fixes
1 parent 3a9ddc1 commit e4549e5

File tree

5 files changed

+8
-8
lines changed

5 files changed

+8
-8
lines changed

iroh-relay/src/server/client.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -259,7 +259,7 @@ struct Actor {
259259
disco_send_queue: mpsc::Receiver<Packet>,
260260
/// Notify the client that a previous sender has disconnected
261261
endpoint_gone: mpsc::Receiver<PublicKey>,
262-
/// [`EndpointId`] of this client
262+
/// [`PublicKey`] of this client
263263
endpoint_id: PublicKey,
264264
/// Connection identifier.
265265
connection_id: u64,

iroh-relay/src/server/clients.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ impl Clients {
105105
}
106106
}
107107

108-
/// Attempt to send a packet to client with [`EndpointId`] `dst`.
108+
/// Attempt to send a packet to client with [`PublicKey`] `dst`.
109109
pub(super) fn send_packet(
110110
&self,
111111
dst: PublicKey,
@@ -145,7 +145,7 @@ impl Clients {
145145
}
146146
}
147147

148-
/// Attempt to send a disco packet to client with [`EndpointId`] `dst`.
148+
/// Attempt to send a disco packet to client with [`PublicKey`] `dst`.
149149
pub(super) fn send_disco_packet(
150150
&self,
151151
dst: PublicKey,

iroh/src/magicsock/endpoint_map.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -326,7 +326,7 @@ impl EndpointMap {
326326
self.inner.lock().expect("poisoned").latency(endpoint_id)
327327
}
328328

329-
/// Get the [`RemoteInfo`]s for the endpoint identified by [`EndpointId`].
329+
/// Get the [`RemoteInfo`]s for the endpoint identified by [`PublicKey`].
330330
pub(super) fn remote_info(&self, endpoint_id: PublicKey) -> Option<RemoteInfo> {
331331
self.inner
332332
.lock()

iroh/src/magicsock/transports/relay/actor.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -782,7 +782,7 @@ struct ConnectedRelayState {
782782
ping_tracker: PingTracker,
783783
/// Endpoints which are reachable via this relay server.
784784
endpoints_present: BTreeSet<PublicKey>,
785-
/// The [`EndpointId`] from whom we received the last packet.
785+
/// The [`PublicKey`] from whom we received the last packet.
786786
///
787787
/// This is to avoid a slower lookup in the [`ConnectedRelayState::endpoints_present`] map
788788
/// when we are only communicating to a single remote endpoint.

iroh/src/test_utils.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -470,13 +470,13 @@ pub(crate) mod pkarr_dns_state {
470470
}
471471
}
472472

473-
/// Parses a [`EndpointId`] from a DNS domain name.
473+
/// Parses a [`PublicKey`] from a DNS domain name.
474474
///
475475
/// Splits the domain name into labels on each dot. Expects the first label to be
476-
/// [`IROH_TXT_NAME`] and the second label to be a z32 encoded [`EndpointId`]. Ignores
476+
/// [`IROH_TXT_NAME`] and the second label to be a z32 encoded [`PublicKey`]. Ignores
477477
/// subsequent labels.
478478
///
479-
/// Returns a [`EndpointId`] if parsed successfully, otherwise `None`.
479+
/// Returns a [`PublicKey`] if parsed successfully, otherwise `None`.
480480
fn endpoint_id_from_domain_name(name: &str) -> Option<PublicKey> {
481481
let mut labels = name.split(".");
482482
let label = labels.next()?;

0 commit comments

Comments
 (0)