Skip to content
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

Jump to bottom

docs(iroh-net): Minor tweaks in the public iroh_net::dns module #2289

Merged
merged 3 commits into from
May 14, 2024
Merged

docs(iroh-net): Minor tweaks in the public iroh_net::dns module #2289

merged 3 commits into from
May 14, 2024

Conversation

flub
Copy link
Contributor

@flub flub commented May 14, 2024

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

  • Self-review.
  • Documentation updates if relevant.
  • Tests if relevant.
  • All breaking changes documented.

@flub
docs(iroh-net): Minor tweaks in the public iroh_net::dns module
5edf22d 
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.
@flub flub requested a review from Frando May 14, 2024 12:26
@flub flub enabled auto-merge May 14, 2024 12:27
divagant-martian
divagant-martian reviewed May 14, 2024
View reviewed changes
Copy link
Contributor

@divagant-martian divagant-martian left a comment •
edited
Loading

Choose a reason for hiding this comment

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

I like it. Only nitpick to your nitpicks is that using _iroh if at any point requires us to change it is doing text search for a potentially common thing. Referencing the constants is clearer and easier to maintain imo

iroh-net/src/dns/node_info.rs Outdated Show resolved Hide resolved
iroh-net/src/dns/node_info.rs Outdated Show resolved Hide resolved
iroh-net/src/dns/node_info.rs Outdated Show resolved Hide resolved
flub and others added 2 commits May 14, 2024 17:39
@flub @divagant-martian
fix typo
c092b4a 
Co-authored-by: Divma <26765164+divagant-martian@users.noreply.github.com>
@flub
Use IROH_TXT_NAME and N0_DNS_NODE_ORIGIN constants where possible
d08493a
divagant-martian
divagant-martian approved these changes May 14, 2024
View reviewed changes
Copy link
Contributor

@divagant-martian divagant-martian left a comment

Choose a reason for hiding this comment

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

love the clarity and the standardization of style

@flub flub added this pull request to the merge queue May 14, 2024
@Frando
Copy link
Member

Frando commented 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.

Merged via the queue into main with commit 3f6b8e7 May 14, 2024
22 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@divagant-martian divagant-martian divagant-martian approved these changes

@Frando Frando Awaiting requested review from Frando

Assignees
No one assigned
Labels
None yet
Projects
iroh
Archived in project
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@flub @Frando @divagant-martian