doc: fix dnsPromises.lookup verbatim default#64658
Open
BIGSUS24 wants to merge 1 commit into
Open
Conversation
The verbatim default flipped to true in v17 (nodejs#39987), but the dnsPromises.lookup docs still say false. The order bullet right above it and the dns.lookup section both already say the addresses are not reordered by default, so this bullet was contradicting them. Signed-off-by: BIGSUS24 <152616194+BIGSUS24@users.noreply.github.com>
Collaborator
|
Review requested:
|
nodejs-github-bot
added
dns
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
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.
The
verbatimoption fordnsPromises.lookup()documents its default asfalse(addresses reordered), but that's stale. The default flipped totruein v17 (#39987), same as the callbackdns.lookup().You can see it contradicts itself already: the
orderbullet right above saysverbatim(addresses are not reordered) by default, and thedns.lookup()section documents the sameverbatimoption astrue. Source confirms it too — both paths start fromDNS_ORDER_VERBATIM(lib/dns.js,lib/internal/dns/promises.js), with the global default set to'verbatim'inlib/internal/dns/utils.js.This just updates the
dnsPromises.lookup()bullet to match. Docs only.