Skip to content

Commit

Permalink
docs(relay): fix typos in map.rs (#2773)
Browse files Browse the repository at this point in the history
## Description

Just some typos fix.

## Breaking Changes

<!-- Optional, if there are any breaking changes document them,
including how to migrate older code. -->

## Notes & open questions

<!-- Any notes, remarks or open questions you have to make about the PR.
-->

## Change checklist

- [x] Self-review.
- [x] Documentation updates following the [style
guide](https://rust-lang.github.io/rfcs/1574-more-api-documentation-conventions.html#appendix-a-full-conventions-text),
if relevant.
- [ ] Tests if relevant.
- [ ] All breaking changes documented.
  • Loading branch information
dzvon authored Oct 2, 2024
1 parent f536789 commit 73ca58a
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions iroh-net/src/relay/map.rs
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ impl RelayMap {
self.nodes.is_empty()
}

/// Creates a new [`RelayMap] with a single relay server configured.
/// Creates a new [`RelayMap`] with a single relay server configured.
///
/// Allows to set a custom STUN port and different IP addresses for IPv4 and IPv6.
/// If IP addresses are provided, no DNS lookup will be performed.
Expand All @@ -104,15 +104,15 @@ impl RelayMap {
}
}

/// Returns a [`RelayMap] from a [`RelayUrl`].
/// Returns a [`RelayMap`] from a [`RelayUrl`].
///
/// This will use the default STUN port and IP addresses resolved from the URL's host name via DNS.
/// relay nodes are specified at <../../../docs/relay_nodes.md>
/// relay nodes are specified at <../../docs/relay_nodes.md>
pub fn from_url(url: RelayUrl) -> Self {
Self::default_from_node(url, DEFAULT_STUN_PORT)
}

/// Constructs the [`RelayMap] from an iterator of [`RelayNode`]s.
/// Constructs the [`RelayMap`] from an iterator of [`RelayNode`]s.
pub fn from_nodes(value: impl IntoIterator<Item = RelayNode>) -> Result<Self> {
let mut map = BTreeMap::new();
for node in value.into_iter() {
Expand Down

0 comments on commit 73ca58a

Please sign in to comment.