Skip to content

Commit 71d5136

Browse files
authored
docs(iroh): fix documentation on endpoint::Builder::empty (#3592)
# Description Fixes a small documentation error. See also the discussion on discord: https://discord.com/channels/1161119546170687619/1161119546644627528/1433606524336476182 > No, the docs are wrong —from a previous iteration that did not take a relay mode as an argument. > We want folks to be forced to choose a relay mode, there are too many footguns that can happen if you don't think about your specific use case.
1 parent b057b91 commit 71d5136

File tree

1 file changed

+1
-2
lines changed

1 file changed

+1
-2
lines changed

iroh/src/endpoint.rs

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -136,8 +136,7 @@ impl Builder {
136136
self
137137
}
138138

139-
/// Creates an empty builder, which means there are no relays
140-
/// and no discovery services configured.
139+
/// Creates an empty builder with no discovery services.
141140
pub fn empty(relay_mode: RelayMode) -> Self {
142141
let mut transport_config = quinn::TransportConfig::default();
143142
transport_config.keep_alive_interval(Some(Duration::from_secs(1)));

0 commit comments

Comments
 (0)