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

doc: dns.resolve wrong callback addresses argument description #6506

Closed
MrQubo opened this issue May 1, 2016 · 5 comments
Closed

doc: dns.resolve wrong callback addresses argument description #6506

MrQubo opened this issue May 1, 2016 · 5 comments
Labels
dns Issues and PRs related to the dns subsystem. doc Issues and PRs related to the documentations. good first issue Issues that are suitable for first-time contributors.

Comments

@MrQubo
Copy link

MrQubo commented May 1, 2016 •
edited by silverwind
Loading

The dns.resolve(hostname[, rrtype], callback) description says:

The callback function has arguments (err, addresses). When successful, addresses will be an array.

But it's not true for SOA record.

dns.resolve documentation:
https://nodejs.org/docs/latest-v6.x/api/dns.html#dns_dns_resolve_hostname_rrtype_callback
@addaleax addaleax added doc Issues and PRs related to the documentations. dns Issues and PRs related to the dns subsystem. labels May 1, 2016
@silverwind
Copy link
Contributor

SOA returns objects. Should be an easy doc addition.

@silverwind silverwind added the good first issue Issues that are suitable for first-time contributors. label May 2, 2016
@JungMinu JungMinu self-assigned this May 3, 2016
@tarungarg546
Copy link
Contributor

Any update. What exactly needs to be done.

@qheaden
Copy link
Contributor

qheaden commented Jul 4, 2016

I would like to work on this one. Feel free to make me an assignee on this so others will know I am working on it. I will update the DNS module docs.

@qheaden
Copy link
Contributor

qheaden commented Jul 4, 2016

I see that the dns.resolveSoa() method documents the object correctly. Should that information be copied to the dns.resolve() documentation, or should it just point users to dns.resolveSoa() to explain the SOA record object?

@qheaden qheaden mentioned this issue Jul 4, 2016
Closed
2 tasks
@silverwind
Copy link
Contributor

Should that information be copied to the dns.resolve() documentation, or should it just point users to dns.resolveSoa() to explain the SOA record object?

No need to duplicate that information, just point (link) to it.

MylesBorins pushed a commit that referenced this issue Jul 12, 2016
@qheaden
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 <[email protected]>
Reviewed-By: Roman Reiss <[email protected]>
MylesBorins pushed a commit that referenced this issue Jul 12, 2016
@qheaden @MylesBorins
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 <[email protected]>
Reviewed-By: Roman Reiss <[email protected]>
MylesBorins pushed a commit that referenced this issue Jul 12, 2016
@qheaden
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 <[email protected]>
Reviewed-By: Roman Reiss <[email protected]>
MylesBorins pushed a commit that referenced this issue Jul 12, 2016
@qheaden
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 <[email protected]>
Reviewed-By: Roman Reiss <[email protected]>
MylesBorins pushed a commit that referenced this issue Jul 14, 2016
@qheaden
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 <[email protected]>
Reviewed-By: Roman Reiss <[email protected]>
MylesBorins pushed a commit that referenced this issue Jul 14, 2016
@qheaden
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 <[email protected]>
Reviewed-By: Roman Reiss <[email protected]>
evanlucas pushed a commit that referenced this issue Jul 15, 2016
@qheaden @evanlucas
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 <[email protected]>
Reviewed-By: Roman Reiss <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
dns Issues and PRs related to the dns subsystem. doc Issues and PRs related to the documentations. good first issue Issues that are suitable for first-time contributors.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

doc: dns.resolve wrong callback addresses argument description.
6 participants
@silverwind @addaleax @JungMinu @qheaden @tarungarg546 @MrQubo