docs(iroh-net): Update discovery and dialing docs, signatures #2472
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This updates the documentationfor the dialing and discovery modules. It also fixes up some signatures to be more consistent with the rest of iroh-net: - NodeId is used to identify an iroh-net node that is communicated with. PublicKey is only used in contexts where encryption/decryption happens - NodeId is Copy and we pass it by value normally. Not by reference. Some more changes: - DialFuture is entirely unused, probably left over from a refactor. Removed. - Use pub(super) explicitly, helps clarity of intention as well as dead-code detection.
matheus23
approved these changes
Jul 8, 2024
Co-authored-by: Philipp Krüger <[email protected]>
|
I really need to work on my commas... thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This updates the documentationfor the dialing and discovery modules.
It also fixes up some signatures to be more consistent with the rest
of iroh-net:
NodeId is used to identify an iroh-net node that is communicated
with. PublicKey is only used in contexts where
encryption/decryption happens
NodeId is Copy and we pass it by value normally. Not by reference.
Some more changes:
DialFuture is entirely unused, probably left over from a refactor.
Removed.
Use pub(super) explicitly, helps clarity of intention as well as
dead-code detection.
Breaking Changes
The following APIs now take NodeId by value rather than by reference:
Other changes:
Notes & open questions
Change checklist
[ ] Tests if relevant.