doc: clarify setServer method #21469
Closed
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
dns
Shivang44
changed the title
Added a note that that clarifies the fact that setServer does not check subsequent servers when the first one produces a NOTFOUND error.
Shivang44
changed the title
|
@Shivang44 hi, Thank you. |
jasnell
reviewed
Jun 22, 2018
doc/api/dns.md
Outdated
| @@ -1010,6 +1010,8 @@ An error will be thrown if an invalid address is provided. | |||
| The `dnsPromises.setServers()` method must not be called while a DNS query is in | |||
| progress. | |||
|
|
|||
| Note that this method works much like [resolve.conf in Linux](http://man7.org/linux/man-pages/man5/resolv.conf.5.html). That is, if attempting to resolve with the first server provided results in a `NOTFOUND` error, the `resolve` method will *not* attempt to resolve with subsequent servers provided. Fallback DNS servers will only be used if the earlier ones time out or result in some other error. | |||
|
This only addresses |
Lint was failing because doc was not under 80 lines.
doc/api/dns.md
Outdated
| Note that this method works much like | ||
| [resolve.conf](http://man7.org/linux/man-pages/man5/resolv.conf.5.html). | ||
| That is, if attempting to resolve with the first server provided results in a | ||
| `NOTFOUND` error, the `resolve` method will *not* attempt to resolve with |
There was a problem hiding this comment.
Nit: `resolve` -> `resolve()`?
(see STYLE_GUIDE.md about references to methods format)
There was a problem hiding this comment.
Sorry, did not see that.
Added note about setServers in dnsPromises to dns as well.
Updated methods in doc to include parentheses.
|
Thanks for all the feedback everyone. I updated to reflect all current comments. |
trivikr
approved these changes
Jun 23, 2018
jasnell
approved these changes
Jun 24, 2018
vsemozhetbyt
pushed a commit
that referenced
this pull request
Jun 25, 2018
Added a note that that clarifies the fact that setServers() does not check subsequent servers when the first one produces a NOTFOUND error. PR-URL: #21469 Refs: #21391 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
|
Landed in 95205a6 |
targos
pushed a commit
that referenced
this pull request
Jun 26, 2018
Added a note that that clarifies the fact that setServers() does not check subsequent servers when the first one produces a NOTFOUND error. PR-URL: #21469 Refs: #21391 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
Merged
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.
Added a note that that clarifies the fact that setServer does not
check subsequent servers when the first one produces a NOTFOUND
error.
Refs: #21391