doc: fix dns.lookup and dnsPromises.lookup description

PR-URL: #51517 Fixes: #51482 Reviewed-By: Paolo Insogna <[email protected]> Reviewed-By: Matteo Collina <[email protected]>
nodejs · Mar 25, 2024 · 2d98906 · 2d98906
1 parent 2615235
commit 2d98906
Showing 1 changed file with 6 additions and 4 deletions.
diff --git a/doc/api/dns.md b/doc/api/dns.md
@@ -204,8 +204,9 @@ changes:
 * `options` {integer | Object}
   * `family` {integer|string} The record family. Must be `4`, `6`, or `0`. For
     backward compatibility reasons,`'IPv4'` and `'IPv6'` are interpreted as `4`
-    and `6` respectively. The value `0` indicates that IPv4 and IPv6 addresses
-    are both returned. **Default:** `0`.
+    and `6` respectively. The value `0` indicates that either an IPv4 or IPv6
+    address is returned. If the value `0` is used with `{ all: true } (see below)`,
+    both IPv4 and IPv6 addresses are returned. **Default:** `0`.
   * `hints` {number} One or more [supported `getaddrinfo` flags][]. Multiple
     flags may be passed by bitwise `OR`ing their values.
   * `all` {boolean} When `true`, the callback returns all resolved addresses in
@@ -951,8 +952,9 @@ added: v10.6.0
 * `hostname` {string}
 * `options` {integer | Object}
   * `family` {integer} The record family. Must be `4`, `6`, or `0`. The value
-    `0` indicates that IPv4 and IPv6 addresses are both returned. **Default:**
-    `0`.
+    `0` indicates that either an IPv4 or IPv6 address is returned. If the
+    value `0` is used with `{ all: true }` (see below), both IPv4 and IPv6
+    addresses are returned. **Default:** `0`.
   * `hints` {number} One or more [supported `getaddrinfo` flags][]. Multiple
     flags may be passed by bitwise `OR`ing their values.
   * `all` {boolean} When `true`, the `Promise` is resolved with all addresses in