doc: fix confusing example in dns.md #11022

Closed
wants to merge 1 commit into
from

Conversation

Projects
None yet
5 participants
@vsemozhetbyt
Member

vsemozhetbyt commented Jan 26, 2017

Checklist
  • documentation is changed or added
  • commit message follows commit guidelines
Affected core subsystem(s)

doc, dns

Currently, the second example throws Error: getHostByAddr ENOTFOUND [IP]. Somebody even posts a question in stackoverflow.com for this very example recently.

Unfortunately, more neutral hostnames (like example.com or github.com) produce the same error. So I've replaced nodejs.org by google.com. If I should use something else, please, tell me.

The previous adjacent example is edited for consistency.

@Trott

This comment has been minimized.

Show comment
Hide comment
@Trott

Trott Jan 26, 2017

Member

I'd prefer we avoid corporate entities in our example URLs. Not enough to object to this landing, but enough to suggest some alternatives. (I tested these all and they work in the reverse lookup example in the StackOverflow question, at least.) Maybe use each of these in one example?:

  • iana.org
  • wikipedia.org
  • archive.org
  • iso.org
Member

Trott commented Jan 26, 2017

I'd prefer we avoid corporate entities in our example URLs. Not enough to object to this landing, but enough to suggest some alternatives. (I tested these all and they work in the reverse lookup example in the StackOverflow question, at least.) Maybe use each of these in one example?:

  • iana.org
  • wikipedia.org
  • archive.org
  • iso.org
@vsemozhetbyt

This comment has been minimized.

Show comment
Hide comment
@vsemozhetbyt

vsemozhetbyt Jan 26, 2017

Member

@Trott

Maybe use each of these in one example

Does it mean iteration over hostnames array?

Member

vsemozhetbyt commented Jan 26, 2017

@Trott

Maybe use each of these in one example

Does it mean iteration over hostnames array?

@Trott

This comment has been minimized.

Show comment
Hide comment
@Trott

Trott Jan 26, 2017

Member

Does it mean iteration over hostnames array?

I mean: There are four code examples changed in this PR. In one of those, use iana.org. In the next one, use wikipedia.org. And so on. Just a suggestion.

Member

Trott commented Jan 26, 2017

Does it mean iteration over hostnames array?

I mean: There are four code examples changed in this PR. In one of those, use iana.org. In the next one, use wikipedia.org. And so on. Just a suggestion.

@vsemozhetbyt

This comment has been minimized.

Show comment
Hide comment
@vsemozhetbyt

vsemozhetbyt Jan 26, 2017

Member

@Trott Sorry, there are two examples and two comments for them. So it could be only two hostnames. But these two examples illustrate 'functions belonging to two different categories', i.e. they are used in a somehow comparative way. Should we use different hostnames in them?

Member

vsemozhetbyt commented Jan 26, 2017

@Trott Sorry, there are two examples and two comments for them. So it could be only two hostnames. But these two examples illustrate 'functions belonging to two different categories', i.e. they are used in a somehow comparative way. Should we use different hostnames in them?

@Trott

This comment has been minimized.

Show comment
Hide comment
@Trott

Trott Jan 26, 2017

Member

Oh, my mistake, I see now, yes, just two examples.

I don't think it matters much if you use the same hostname in the two examples or different hostnames in each. It was just an idea. Do whichever you think is better!

Member

Trott commented Jan 26, 2017

Oh, my mistake, I see now, yes, just two examples.

I don't think it matters much if you use the same hostname in the two examples or different hostnames in each. It was just an idea. Do whichever you think is better!

doc: fix confusing example in dns.md
Currently, the example throws 'Error: getHostByAddr ENOTFOUND'
The previous example is edited for consistency.
@vsemozhetbyt

This comment has been minimized.

Show comment
Hide comment
@vsemozhetbyt

vsemozhetbyt Jan 26, 2017

Member

@Trott I've used the archive.org in the second example as it has most similar input and output forms. Thank you for the suggestions!

Member

vsemozhetbyt commented Jan 26, 2017

@Trott I've used the archive.org in the second example as it has most similar input and output forms. Thank you for the suggestions!

@jasnell

This comment has been minimized.

Show comment
Hide comment
@jasnell

jasnell Jan 27, 2017

Member

Odd that it happens with example.org...

Member

jasnell commented Jan 27, 2017

Odd that it happens with example.org...

@vsemozhetbyt

This comment has been minimized.

Show comment
Hide comment
@vsemozhetbyt

vsemozhetbyt Jan 31, 2017

Member

@Trott , @gibfahn , @jasnell Could this be landed?

Member

vsemozhetbyt commented Jan 31, 2017

@Trott , @gibfahn , @jasnell Could this be landed?

@gibfahn gibfahn self-assigned this Jan 31, 2017

@gibfahn

This comment has been minimized.

Show comment
Hide comment
@gibfahn

gibfahn Jan 31, 2017

Member

@Trott does this LGTY?

Member

gibfahn commented Jan 31, 2017

@Trott does this LGTY?

@Trott

Trott approved these changes Jan 31, 2017

LGTM

@gibfahn

This comment has been minimized.

Show comment
Hide comment
@gibfahn

gibfahn Jan 31, 2017

Member

Landed in 110b7cf

Member

gibfahn commented Jan 31, 2017

Landed in 110b7cf

@gibfahn gibfahn closed this Jan 31, 2017

gibfahn added a commit that referenced this pull request Jan 31, 2017

doc: fix confusing example in dns.md
Currently, the example throws 'Error: getHostByAddr ENOTFOUND'
The previous example is edited for consistency.

PR-URL: #11022
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>

@vsemozhetbyt vsemozhetbyt deleted the vsemozhetbyt:dns.md branch Jan 31, 2017

italoacasas added a commit to italoacasas/node that referenced this pull request Feb 2, 2017

doc: fix confusing example in dns.md
Currently, the example throws 'Error: getHostByAddr ENOTFOUND'
The previous example is edited for consistency.

PR-URL: nodejs#11022
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>

jasnell added a commit that referenced this pull request Mar 7, 2017

doc: fix confusing example in dns.md
Currently, the example throws 'Error: getHostByAddr ENOTFOUND'
The previous example is edited for consistency.

PR-URL: #11022
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>

jasnell added a commit that referenced this pull request Mar 7, 2017

doc: fix confusing example in dns.md
Currently, the example throws 'Error: getHostByAddr ENOTFOUND'
The previous example is edited for consistency.

PR-URL: #11022
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>

MylesBorins added a commit that referenced this pull request Mar 9, 2017

doc: fix confusing example in dns.md
Currently, the example throws 'Error: getHostByAddr ENOTFOUND'
The previous example is edited for consistency.

PR-URL: #11022
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>

@MylesBorins MylesBorins referenced this pull request Mar 9, 2017

Merged

v6.10.1 proposal #11759

MylesBorins added a commit that referenced this pull request Mar 9, 2017

doc: fix confusing example in dns.md
Currently, the example throws 'Error: getHostByAddr ENOTFOUND'
The previous example is edited for consistency.

PR-URL: #11022
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>

@MylesBorins MylesBorins referenced this pull request Mar 9, 2017

Merged

v4.8.1 proposal #11760

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment