doc: dns.resolve wrong callback addresses argument description. #7532
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
nodejs-github-bot
added
doc
| determined by the record type, and described in the documentation for the | ||
| corresponding lookup methods. | ||
| `addresses` will be an array. If resolving an SOA record, it will return an | ||
| object with the same structure as is returned by the dns.resolveSoa method. |
There was a problem hiding this comment.
Can you code highlight dns.resolveSoa and provide a link?
There was a problem hiding this comment.
Also, shouldn't it mention what would be the returned values if it is not an SOA record?
There was a problem hiding this comment.
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
|
@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? |
|
I was able to verify the link worked correctly by generating the docs myself using 'make doc'. |
|
LGTM |
|
LGTM, landing this… |
|
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>
Merged
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>
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.
Checklist
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