Skip to content

Commit c856129

Browse files
Fix typos and broken doc-links
1 parent 6a061a0 commit c856129

File tree

2 files changed

+5
-9
lines changed

2 files changed

+5
-9
lines changed

Diff for: mullvad-relay-selector/src/relay_selector/detailer.rs

+4-8
Original file line numberDiff line numberDiff line change
@@ -29,14 +29,10 @@ use super::{
2929

3030
/// Constructs a [`MullvadWireguardEndpoint`] with details for how to connect to a Wireguard relay.
3131
///
32-
/// If entry is `None`, `to_endpoint` configures a single-hop connection using the exit relay data.
33-
/// Otherwise, it constructs a multihop setup using both entry and exit to set up appropriate peer
34-
/// configurations.
35-
///
3632
/// # Returns
37-
/// - A configured Mullvad endpoint for Wireguard, encapsulating either a single-hop or multi-hop connection setup.
38-
/// - Returns `None` if the desired port is not in a valid port range (see
39-
/// [`WireguradRelayQuery::port`]) or relay addresses cannot be resolved.
33+
/// - A configured endpoint for Wireguard relay, encapsulating either a single-hop or multi-hop connection.
34+
/// - Returns [`Option::None`] if the desired port is not in a valid port range (see
35+
/// [`WireguardRelayQuery::port`]) or relay addresses cannot be resolved.
4036
pub fn wireguard_endpoint(
4137
query: &WireguardRelayQuery,
4238
data: &WireguardEndpointData,
@@ -97,7 +93,7 @@ fn wireguard_multihop_endpoint(
9793
let exit = PeerConfig {
9894
public_key: exit.endpoint_data.unwrap_wireguard_ref().public_key.clone(),
9995
endpoint: exit_endpoint,
100-
// The exit peer should be able to route incomming VPN traffic to the rest of
96+
// The exit peer should be able to route incoming VPN traffic to the rest of
10197
// the internet.
10298
allowed_ips: all_of_the_internet(),
10399
// This will be filled in later, not the relay selector's problem

Diff for: mullvad-relay-selector/src/relay_selector/helpers.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ pub fn random<'a, A: PartialEq>(
2626
.choose(&mut thread_rng())
2727
}
2828

29-
/// Picks a relay using [Self::pick_random_relay_fn], using the `weight` member of each relay
29+
/// Picks a relay using [pick_random_relay_fn], using the `weight` member of each relay
3030
/// as the weight function.
3131
pub fn pick_random_relay(relays: &[Relay]) -> Option<&Relay> {
3232
pick_random_relay_fn(relays, |relay| relay.weight)

0 commit comments

Comments
 (0)