docs(iroh-net): Update NodeAddr docs #2365
Merged
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 follows https://github.com/rust-lang/rfcs/blob/master/text/1574-more-api-documentation-conventions.md#appendix-a-full-conventions-text and updates the doc comments in an attempt to be more user-friendly.
matheus23
reviewed
Jun 17, 2024
matheus23
approved these changes
Jun 17, 2024
Comment on lines
+38
to
+40
| /// [discovery]: https://docs.rs/iroh_net/*/iroh_net/index.html#node-discovery | ||
| /// [home relay]: https://docs.rs/iroh_net/*/iroh_net/relay/index.html | ||
| /// [Relay server]: https://docs.rs/iroh_net/*/iroh_net/index.html#relay-servers |
There was a problem hiding this comment.
As far as I'm aware this type of links are not verified when checking docs so, while these make sense, it would be good to avoid them in general
There was a problem hiding this comment.
@divagant-martian do you now how to link these without having to write them down like this? I first tried to write this as iroh_net#relay-servers or even iroh_net but I didn't know how to do inter-crate links and this was the only thing I could come up with.
| }, | ||
| } | ||
| } | ||
|
|
||
| /// Apply the options to `self`. |
There was a problem hiding this comment.
bit late but this one was missed
| /// Apply the options to `self`. | ||
| /// | ||
| /// This is use to more tightly control the information stored in a [`NodeAddr`] |
There was a problem hiding this comment.
Suggested change
| /// This is use to more tightly control the information stored in a [`NodeAddr`] | |
| /// This is used to more tightly control the information stored in a [`NodeAddr`] |
| /// Apply the options to `self`. | ||
| /// Applies the options to `self`. | ||
| /// | ||
| /// This is use to more tightly control the information stored in ab [`AddrInfo`] |
There was a problem hiding this comment.
Suggested change
| /// This is use to more tightly control the information stored in ab [`AddrInfo`] | |
| /// This is used to more tightly control the information stored in ab [`AddrInfo`] |
2 tasks
github-merge-queue bot
pushed a commit
that referenced
this pull request
Jun 17, 2024
## Description Some minor typos missed earlier. ## Breaking Changes <!-- Optional, if there are any breaking changes document them, including how to migrate older code. --> ## Notes & open questions Followup from #2365 ## Change checklist - [x] Self-review. - [x] Documentation updates if relevant. - ~~[ ] Tests if relevant.~~ - ~~[ ] All breaking changes documented.~~
ppodolsky
pushed a commit
to izihawa/iroh
that referenced
this pull request
Jun 22, 2024
## Description This follows https://github.com/rust-lang/rfcs/blob/master/text/1574-more-api-documentation-conventions.md#appendix-a-full-conventions-text and updates the doc comments in an attempt to be more user-friendly. ## 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 if relevant. - ~~[ ] Tests if relevant.~~ - ~~[ ] All breaking changes documented.~~
ppodolsky
pushed a commit
to izihawa/iroh
that referenced
this pull request
Jun 22, 2024
## Description Some minor typos missed earlier. ## Breaking Changes <!-- Optional, if there are any breaking changes document them, including how to migrate older code. --> ## Notes & open questions Followup from n0-computer#2365 ## Change checklist - [x] Self-review. - [x] Documentation updates if relevant. - ~~[ ] Tests if relevant.~~ - ~~[ ] All breaking changes documented.~~
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 follows
https://github.com/rust-lang/rfcs/blob/master/text/1574-more-api-documentation-conventions.md#appendix-a-full-conventions-text
and updates the doc comments in an attempt to be more user-friendly.
Breaking Changes
Notes & open questions
Change checklist
[ ] Tests if relevant.[ ] All breaking changes documented.