FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

doc: dns.resolve wrong callback addresses argument description. by qheaden · Pull Request #7532 · nodejs/node · GitHub

/ node Public

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

Closed
qheaden wants to merge 1 commit into
nodejs:masterfrom
qheaden:issue-6506
ConversationCommits (1)ChecksFiles changed
Closed

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

Conversation

qheaden commented Jul 4, 2016 •
edited
Loading

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-bot added doc Issues and PRs related to the documentations. dns Issues and PRs related to the dns subsystem. labels Jul 4, 2016
thefourtheye reviewed Jul 4, 2016
View reviewed changes
Comment thread doc/api/dns.md Outdated

thefourtheye Jul 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.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

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

thefourtheye Jul 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.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

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

silverwind Jul 4, 2016 •
edited
Loading

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.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

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

doc: dns.resolve wrong callback addresses argument description.
727e940 
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 commented Jul 4, 2016

Copy link
Copy Markdown
Contributor Author

@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 commented Jul 5, 2016

Copy link
Copy Markdown
Contributor Author

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

silverwind commented Jul 5, 2016

Copy link
Copy Markdown
Contributor

LGTM

addaleax commented Jul 11, 2016

Copy link
Copy Markdown
Member

LGTM, landing this…

addaleax commented Jul 11, 2016

Copy link
Copy Markdown
Member

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

addaleax closed this Jul 11, 2016
addaleax pushed a commit that referenced this pull request Jul 11, 2016
doc: dns.resolve fix callback argument description
fcae5e2 
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 mentioned this pull request Jul 11, 2016
Closed
MylesBorins pushed a commit that referenced this pull request Jul 12, 2016
doc: dns.resolve fix callback argument description
dfd4964 
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
doc: dns.resolve fix callback argument description
8c929aa 
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
doc: dns.resolve fix callback argument description
91c3c7c 
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
doc: dns.resolve fix callback argument description
572cc69 
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 mentioned this pull request Jul 12, 2016
Merged
MylesBorins pushed a commit that referenced this pull request Jul 14, 2016
doc: dns.resolve fix callback argument description
7bd2666 
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
doc: dns.resolve fix callback argument description
de5e235 
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
doc: dns.resolve fix callback argument description
a81ff70 
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 mentioned this pull request Jul 18, 2016
Merged
This file contains hidden or 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
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

dns Issues and PRs related to the dns subsystem. doc Issues and PRs related to the documentations.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

doc: dns.resolve wrong callback addresses argument description

6 participants

Back | FazBrowse Home | New Git URL