Skip to content

Improve wording for the Builder::discovery fn #3582

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Improve wording for the Builder::discovery fn #3582

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e1825a4
Improve wording for the Builder::discovery fn
matthiasbeyer Oct 29, 2025
aa58a93
Merge branch 'main' into improve-endpoint-builder-discovery-wording
ramfox Oct 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion iroh/src/endpoint.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -308,7 +308,8 @@ impl Builder {
/// the endpoint. Discovery services that need to publish information need
/// to use this secret key to sign the information.
///
/// If you add multiple discovery services, they will be combined using a
/// The internals of the [`Builder`] use the discovery objects passed to this function and
/// automatically combines them upon [`Builder::bind`] via a
Comment on lines +311 to +312
Copy link
Contributor

@flub flub Oct 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you call this method multiple times, all discovery services passed in will be combined via an internal [crate::discovery::ConcurrentDiscovery]. To remove all discovery services already added to the builder use [Self::clear_discovery].

Would be my attempt. And that would remove the separate paragraph about clearing below.

Would be great if you could also fix the wrong function name in the paragraph above and link it to [IntoDiscovery::into_discovery]

/// [`crate::discovery::ConcurrentDiscovery`].
///
/// If no discovery service is set, connecting to an endpoint without providing its
Expand Down
Loading