Skip to content

doc: dns.resolve wrong callback addresses argument description. - #7532

Closed
qheaden wants to merge 1 commit into
nodejs:masterfrom
qheaden:issue-6506
Closed

doc: dns.resolve wrong callback addresses argument description.#7532
qheaden wants to merge 1 commit into
nodejs:masterfrom
qheaden:issue-6506

Conversation

@qheaden

@qheadenqheaden commented Jul 4, 2016

Copy link
Copy Markdown
Contributor
Checklist
  • documentation is changed or added
  • commit message follows commit guidelines
Description of Change

The dns.resolve documentation stated that an array of IP
addresses would be returned in the callback. This is true
for everything other than the SOA record which returns an object.
This fixes that documentation.

Fixes: #6506

@nodejs-github-botnodejs-github-bot added doc Issues and PRs related to the documentations. dns Issues and PRs related to the dns subsystem. labels Jul 4, 2016
Comment threaddoc/api/dns.md Outdated

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Can you code highlight dns.resolveSoa and provide a link?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Also, shouldn't it mention what would be the returned values if it is not an SOA record?

@silverwindsilverwindJul 4, 2016

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Could be worded as "addresses will be an array except when resolving a SOA record where it will be an object".

The dns.resolve documentation stated that an array of IP
addresses would be returned in the callback. This is true
for everything other than the SOA record which returns an object.
This fixes that documentation.
Fixes: #6506
@qheaden

Copy link
Copy Markdown
ContributorAuthor

@thefourtheye@silverwind: I made some changes to the wording, and linked the resolveSoa() method. I'm not sure if I linked correctly. Could someone verify?

@qheaden

Copy link
Copy Markdown
ContributorAuthor

I was able to verify the link worked correctly by generating the docs myself using 'make doc'.

@silverwind

Copy link
Copy Markdown
Contributor

LGTM

@addaleax

Copy link
Copy Markdown
Member

LGTM, landing this…

@addaleax

Copy link
Copy Markdown
Member

Landed in fcae5e2, shortened commit subject a bit to fit into 50 characters. Thanks for the contribution!

addaleax pushed a commit that referenced this pull request Jul 11, 2016
The dns.resolve documentation stated that an array of IP
addresses would be returned in the callback. This is true
for everything other than the SOA record which returns an object.
This fixes that documentation.
Fixes: #6506
PR-URL: #7532
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Roman Reiss <me@silverwind.io>
MylesBorins pushed a commit that referenced this pull request Jul 12, 2016
The dns.resolve documentation stated that an array of IP
addresses would be returned in the callback. This is true
for everything other than the SOA record which returns an object.
This fixes that documentation.
Fixes: #6506
PR-URL: #7532
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Roman Reiss <me@silverwind.io>
MylesBorins pushed a commit that referenced this pull request Jul 12, 2016
The dns.resolve documentation stated that an array of IP
addresses would be returned in the callback. This is true
for everything other than the SOA record which returns an object.
This fixes that documentation.
Fixes: #6506
PR-URL: #7532
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Roman Reiss <me@silverwind.io>
MylesBorins pushed a commit that referenced this pull request Jul 12, 2016
The dns.resolve documentation stated that an array of IP
addresses would be returned in the callback. This is true
for everything other than the SOA record which returns an object.
This fixes that documentation.
Fixes: #6506
PR-URL: #7532
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Roman Reiss <me@silverwind.io>
MylesBorins pushed a commit that referenced this pull request Jul 12, 2016
The dns.resolve documentation stated that an array of IP
addresses would be returned in the callback. This is true
for everything other than the SOA record which returns an object.
This fixes that documentation.
Fixes: #6506
PR-URL: #7532
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Roman Reiss <me@silverwind.io>
@MylesBorinsMylesBorins mentioned this pull request Jul 12, 2016
MylesBorins pushed a commit that referenced this pull request Jul 14, 2016
The dns.resolve documentation stated that an array of IP
addresses would be returned in the callback. This is true
for everything other than the SOA record which returns an object.
This fixes that documentation.
Fixes: #6506
PR-URL: #7532
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Roman Reiss <me@silverwind.io>
MylesBorins pushed a commit that referenced this pull request Jul 14, 2016
The dns.resolve documentation stated that an array of IP
addresses would be returned in the callback. This is true
for everything other than the SOA record which returns an object.
This fixes that documentation.
Fixes: #6506
PR-URL: #7532
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Roman Reiss <me@silverwind.io>
evanlucas pushed a commit that referenced this pull request Jul 15, 2016
The dns.resolve documentation stated that an array of IP
addresses would be returned in the callback. This is true
for everything other than the SOA record which returns an object.
This fixes that documentation.
Fixes: #6506
PR-URL: #7532
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Roman Reiss <me@silverwind.io>
@evanlucasevanlucas mentioned this pull request Jul 18, 2016
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

dnsIssues and PRs related to the dns subsystem.docIssues and PRs related to the documentations.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

doc: dns.resolve wrong callback addresses argument description

6 participants

@qheaden@silverwind@addaleax@thefourtheye@MylesBorins@nodejs-github-bot