docs(iroh-net): Minor tweaks in the public iroh_net::dns module #2289
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 is a bunch of entirely too much nitpcking on the dns module's documentation, as this is all public: - Describe clearly what this is for and how it works. - Summary line is a single full sentence ending in a full stop. - Summary line is in 3rd person.
Co-authored-by: Divma <[email protected]>
divagant-martian
approved these changes
May 14, 2024
|
Thanks so much for this @flub , this is a great improvement to these docs. Didn't spot anything on a quick readover but had to leave it for now, if I spot anything later I'll do a followup PR. |
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 is a bunch of entirely too much nitpcking on the dns module's
documentation, as this is all public:
Describe clearly what this is for and how it works.
Summary line is a single full sentence ending in a full stop.
Summary line is in 3rd person.
Breaking Changes
Notes & open questions
Change checklist