Skip to content

[v12.x backport] doc: allow <code> in header elements #31108

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

Closed
Trott wants to merge 55 commits into from
Closed

[v12.x backport] doc: allow <code> in header elements #31108

Changes from 1 commit
Commits
Show all changes
55 commits
Select commit Hold shift + click to select a range
0b0cd8d
test: correct header length subtraction
Trott Nov 29, 2019
4e93f23
doc: update socket.bufferSize text
Trott Nov 30, 2019
827c53b
doc: update README.md to fix active/maint times
mhdawson Nov 28, 2019
50a54ce
doc: update signature algorithm in release doc
MylesBorins Nov 26, 2019
043163a
doc: revise REPL uncaught exception text
Trott Nov 30, 2019
2aa8654
test: fix test-benchmark-streams
Trott Dec 2, 2019
6c6ffdd
test: use arrow functions in async-hooks tests
GaryGSC Oct 26, 2019
6a35c38
doc: fix typographical error
Trott Nov 30, 2019
3b096c2
build,win: propagate error codes in vcbuild
joaocgreis Nov 30, 2019
197b616
test: add an indicator `isIBMi`
dmabupt Nov 29, 2019
f3c3b1d
test: add coverage for ERR_TLS_INVALID_PROTOCOL_VERSION
Trott Nov 30, 2019
a83ccf8
test: skip test-domain-error-types in debug mode temporariliy
Trott Nov 24, 2019
0054636
doc: allow <code> in header elements
Trott Dec 23, 2019
424266a
doc,dns: use code markup/markdown in headers
Trott Dec 23, 2019
ef4ecf4
doc: use code markup/markdown in headers in addons documentation
Trott Dec 23, 2019
a933028
doc,assert: use code markup/markdown in headers
Trott Dec 23, 2019
a2bea80
doc,async_hooks: use code markup/markdown in headers
Trott Dec 23, 2019
b4934ef
doc,buffer: use code markup/markdown in headers
Trott Dec 23, 2019
3e07682
doc,child_process: use code markup/markdown in headers
Trott Dec 23, 2019
700e28d
doc,cluster: use code markup/markdown in headers
Trott Dec 24, 2019
d92200a
doc,console: use code markup/markdown in headers
Trott Dec 24, 2019
af66dba
doc,crypto: use code markup/markdown in headers
Trott Dec 24, 2019
e00e4d2
doc: use code markup/markdown in headers in deprecations documentation
Trott Dec 24, 2019
17efccd
doc,dgram: use code markup/markdown in headers
Trott Dec 24, 2019
4eb5e60
doc,domain: use code markup/markdown in headers
Trott Dec 24, 2019
e74fa1e
doc,errors: use code markup/markdown in headers
Trott Dec 24, 2019
c763c70
doc,esm: use code markup/markdown in headers
Trott Dec 24, 2019
b1f2dd6
doc,events: use code markup/markdown in headers
Trott Dec 24, 2019
e91846c
doc,fs: use code markup/markdown in headers
Trott Dec 24, 2019
23f5045
doc: use code markup/markdown in headers in globals documentation
Trott Dec 24, 2019
3e95c86
doc,http: use code markup/markdown in headers
Trott Dec 24, 2019
f6084bc
doc,http2: use code markup/markdown in headers
Trott Dec 24, 2019
eb82113
doc,https: use code markup/markdown in headers
Trott Dec 24, 2019
3ac8493
doc,inspector: use code markup/markdown in headers
Trott Dec 24, 2019
e2a4293
doc,module: use code markup/markdown in headers
Trott Dec 24, 2019
7cce4bb
doc,net: use code markup/markdown in headers
Trott Dec 24, 2019
cc65a3c
doc,os: use code markup/markdown in headers
Trott Dec 24, 2019
7b73674
doc,path: use code markup/markdown in headers
Trott Dec 24, 2019
6885967
doc,perf_hooks: use code markup/markdown in headers
Trott Dec 24, 2019
a8f3310
doc,process: use code markup/markdown in headers
Trott Dec 24, 2019
0c253b9
doc,punycode: use code markup/markdown in headers
Trott Dec 24, 2019
003e188
doc,querystring: use code markup/markdown in headers
Trott Dec 24, 2019
b4b4da4
doc,readline: use code markup/markdown in headers
Trott Dec 24, 2019
728c984
doc,repl: use code markup/markdown in headers
Trott Dec 24, 2019
3a1772c
doc,stream: use code markup/markdown in headers
Trott Dec 24, 2019
13e067b
doc,string_decoder: use code markup/markdown in headers
Trott Dec 24, 2019
e3f26c4
doc,timers: use code markup/markdown in headers
Trott Dec 24, 2019
5a76e25
doc,tls: use code markup/markdown in headers
Trott Dec 24, 2019
3c2c8fa
doc,tty: use code markup/markdown in headers
Trott Dec 24, 2019
a0717c7
doc,url: use code markup/markdown in headers
Trott Dec 24, 2019
1bf0dd7
doc,zlib: use code markup/markdown in headers
Trott Dec 24, 2019
f7a70bb
doc,util: use code markup/markdown in headers
Trott Dec 24, 2019
de8f03a
doc,v8: use code markup/markdown in headers
Trott Dec 24, 2019
58132d5
doc,worker: use code markup/markdown in headers
Trott Dec 24, 2019
113cbef
doc,vm: use code markup/markdown in headers
Trott Dec 25, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
doc,dns: use code markup/markdown in headers 
This will allow us to lint for use of `hostname` in prose without
flagging `hostname` in code within headers. This also allows us to
remove backslash escaping for `[` and `]` inside of header code, which
makes the bare markdown more readable.

PR-URL: #31086
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
  • Loading branch information
@Trott
Trott committed Dec 27, 2019
commit 424266a2edba45eab13236546de2b91f2a2a6f85
74 changes: 37 additions & 37 deletions doc/api/dns.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ The `dns` module contains functions belonging to two different categories:
There are subtle consequences in choosing one over the other, please consult
the [Implementation considerations section][] for more information.

## Class: dns.Resolver
## Class: `dns.Resolver`
<!-- YAML
added: v8.3.0
-->
Expand Down Expand Up @@ -99,15 +99,15 @@ The following methods from the `dns` module are available:
* [`resolver.reverse()`][`dns.reverse()`]
* [`resolver.setServers()`][`dns.setServers()`]

### resolver.cancel()
### `resolver.cancel()`
<!-- YAML
added: v8.3.0
-->

Cancel all outstanding DNS queries made by this resolver. The corresponding
callbacks will be called with an error with code `ECANCELLED`.

## dns.getServers()
## `dns.getServers()`
<!-- YAML
added: v0.11.3
-->
Expand All @@ -128,7 +128,7 @@ section if a custom port is used.
]
```

## dns.lookup(hostname\[, options\], callback)
## `dns.lookup(hostname[, options], callback)`
<!-- YAML
added: v0.1.90
changes:
Expand Down Expand Up @@ -218,7 +218,7 @@ configured. Loopback addresses are not considered.
found, then return IPv4 mapped IPv6 addresses. It is not supported
on some operating systems (e.g FreeBSD 10.1).

## dns.lookupService(address, port, callback)
## `dns.lookupService(address, port, callback)`
<!-- YAML
added: v0.11.14
-->
Expand Down Expand Up @@ -250,7 +250,7 @@ dns.lookupService('127.0.0.1', 22, (err, hostname, service) => {
If this method is invoked as its [`util.promisify()`][]ed version, it returns a
`Promise` for an `Object` with `hostname` and `service` properties.

## dns.resolve(hostname\[, rrtype\], callback)
## `dns.resolve(hostname[, rrtype], callback)`
<!-- YAML
added: v0.1.27
-->
Expand Down Expand Up @@ -283,7 +283,7 @@ records. The type and structure of individual results varies based on `rrtype`:
On error, `err` is an [`Error`][] object, where `err.code` is one of the
[DNS error codes](#dns_error_codes).

## dns.resolve4(hostname\[, options\], callback)
## `dns.resolve4(hostname[, options], callback)`
<!-- YAML
added: v0.1.16
changes:
Expand All @@ -308,7 +308,7 @@ Uses the DNS protocol to resolve a IPv4 addresses (`A` records) for the
will contain an array of IPv4 addresses (e.g.
`['74.125.79.104', '74.125.79.105', '74.125.79.106']`).

## dns.resolve6(hostname\[, options\], callback)
## `dns.resolve6(hostname[, options], callback)`
<!-- YAML
added: v0.1.16
changes:
Expand All @@ -332,7 +332,7 @@ Uses the DNS protocol to resolve a IPv6 addresses (`AAAA` records) for the
`hostname`. The `addresses` argument passed to the `callback` function
will contain an array of IPv6 addresses.

## dns.resolveAny(hostname, callback)
## `dns.resolveAny(hostname, callback)`

* `hostname` {string}
* `callback` {Function}
Expand Down Expand Up @@ -381,7 +381,7 @@ DNS server operators may choose not to respond to `ANY`
queries. It may be better to call individual methods like [`dns.resolve4()`][],
[`dns.resolveMx()`][], and so on. For more details, see [RFC 8482][].

## dns.resolveCname(hostname, callback)
## `dns.resolveCname(hostname, callback)`
<!-- YAML
added: v0.3.2
-->
Expand All @@ -396,7 +396,7 @@ Uses the DNS protocol to resolve `CNAME` records for the `hostname`. The
will contain an array of canonical name records available for the `hostname`
(e.g. `['bar.example.com']`).

## dns.resolveMx(hostname, callback)
## `dns.resolveMx(hostname, callback)`
<!-- YAML
added: v0.1.27
-->
Expand All @@ -411,7 +411,7 @@ Uses the DNS protocol to resolve mail exchange records (`MX` records) for the
contain an array of objects containing both a `priority` and `exchange`
property (e.g. `[{priority: 10, exchange: 'mx.example.com'}, ...]`).

## dns.resolveNaptr(hostname, callback)
## `dns.resolveNaptr(hostname, callback)`
<!-- YAML
added: v0.9.12
-->
Expand Down Expand Up @@ -444,7 +444,7 @@ function will contain an array of objects with the following properties:
}
```

## dns.resolveNs(hostname, callback)
## `dns.resolveNs(hostname, callback)`
<!-- YAML
added: v0.1.90
-->
Expand All @@ -459,7 +459,7 @@ Uses the DNS protocol to resolve name server records (`NS` records) for the
contain an array of name server records available for `hostname`
(e.g. `['ns1.example.com', 'ns2.example.com']`).

## dns.resolvePtr(hostname, callback)
## `dns.resolvePtr(hostname, callback)`
<!-- YAML
added: v6.0.0
-->
Expand All @@ -473,7 +473,7 @@ Uses the DNS protocol to resolve pointer records (`PTR` records) for the
`hostname`. The `addresses` argument passed to the `callback` function will
be an array of strings containing the reply records.

## dns.resolveSoa(hostname, callback)
## `dns.resolveSoa(hostname, callback)`
<!-- YAML
added: v0.11.10
-->
Expand Down Expand Up @@ -508,7 +508,7 @@ be an object with the following properties:
}
```

## dns.resolveSrv(hostname, callback)
## `dns.resolveSrv(hostname, callback)`
<!-- YAML
added: v0.1.27
-->
Expand Down Expand Up @@ -537,7 +537,7 @@ be an array of objects with the following properties:
}
```

## dns.resolveTxt(hostname, callback)
## `dns.resolveTxt(hostname, callback)`
<!-- YAML
added: v0.1.27
-->
Expand All @@ -554,7 +554,7 @@ two-dimensional array of the text records available for `hostname` (e.g.
one record. Depending on the use case, these could be either joined together or
treated separately.

## dns.reverse(ip, callback)
## `dns.reverse(ip, callback)`
<!-- YAML
added: v0.1.16
-->
Expand All @@ -570,7 +570,7 @@ array of hostnames.
On error, `err` is an [`Error`][] object, where `err.code` is
one of the [DNS error codes][].

## dns.setServers(servers)
## `dns.setServers(servers)`
<!-- YAML
added: v0.11.3
-->
Expand Down Expand Up @@ -612,7 +612,7 @@ The `dns.promises` API provides an alternative set of asynchronous DNS methods
that return `Promise` objects rather than using callbacks. The API is accessible
via `require('dns').promises`.

### Class: dnsPromises.Resolver
### Class: `dnsPromises.Resolver`
<!-- YAML
added: v10.6.0
-->
Expand Down Expand Up @@ -658,7 +658,7 @@ The following methods from the `dnsPromises` API are available:
* [`resolver.reverse()`][`dnsPromises.reverse()`]
* [`resolver.setServers()`][`dnsPromises.setServers()`]

### dnsPromises.getServers()
### `dnsPromises.getServers()`
<!-- YAML
added: v10.6.0
-->
Expand All @@ -679,7 +679,7 @@ section if a custom port is used.
]
```

### dnsPromises.lookup(hostname\[, options\])
### `dnsPromises.lookup(hostname[, options])`
<!-- YAML
added: v10.6.0
-->
Expand Down Expand Up @@ -744,7 +744,7 @@ dnsPromises.lookup('example.com', options).then((result) => {
});
```

### dnsPromises.lookupService(address, port)
### `dnsPromises.lookupService(address, port)`
<!-- YAML
added: v10.6.0
-->
Expand All @@ -770,7 +770,7 @@ dnsPromises.lookupService('127.0.0.1', 22).then((result) => {
});
```

### dnsPromises.resolve(hostname\[, rrtype\])
### `dnsPromises.resolve(hostname[, rrtype])`
<!-- YAML
added: v10.6.0
-->
Expand Down Expand Up @@ -800,7 +800,7 @@ based on `rrtype`:
On error, the `Promise` is rejected with an [`Error`][] object, where `err.code`
is one of the [DNS error codes](#dns_error_codes).

### dnsPromises.resolve4(hostname\[, options\])
### `dnsPromises.resolve4(hostname[, options])`
<!-- YAML
added: v10.6.0
-->
Expand All @@ -816,7 +816,7 @@ Uses the DNS protocol to resolve IPv4 addresses (`A` records) for the
`hostname`. On success, the `Promise` is resolved with an array of IPv4
addresses (e.g. `['74.125.79.104', '74.125.79.105', '74.125.79.106']`).

### dnsPromises.resolve6(hostname\[, options\])
### `dnsPromises.resolve6(hostname[, options])`
<!-- YAML
added: v10.6.0
-->
Expand All @@ -832,7 +832,7 @@ Uses the DNS protocol to resolve IPv6 addresses (`AAAA` records) for the
`hostname`. On success, the `Promise` is resolved with an array of IPv6
addresses.

### dnsPromises.resolveAny(hostname)
### `dnsPromises.resolveAny(hostname)`
<!-- YAML
added: v10.6.0
-->
Expand Down Expand Up @@ -877,7 +877,7 @@ Here is an example of the result object:
minttl: 60 } ]
```

### dnsPromises.resolveCname(hostname)
### `dnsPromises.resolveCname(hostname)`
<!-- YAML
added: v10.6.0
-->
Expand All @@ -888,7 +888,7 @@ Uses the DNS protocol to resolve `CNAME` records for the `hostname`. On success,
the `Promise` is resolved with an array of canonical name records available for
the `hostname` (e.g. `['bar.example.com']`).

### dnsPromises.resolveMx(hostname)
### `dnsPromises.resolveMx(hostname)`
<!-- YAML
added: v10.6.0
-->
Expand All @@ -900,7 +900,7 @@ Uses the DNS protocol to resolve mail exchange records (`MX` records) for the
containing both a `priority` and `exchange` property (e.g.
`[{priority: 10, exchange: 'mx.example.com'}, ...]`).

### dnsPromises.resolveNaptr(hostname)
### `dnsPromises.resolveNaptr(hostname)`
<!-- YAML
added: v10.6.0
-->
Expand Down Expand Up @@ -930,7 +930,7 @@ of objects with the following properties:
}
```

### dnsPromises.resolveNs(hostname)
### `dnsPromises.resolveNs(hostname)`
<!-- YAML
added: v10.6.0
-->
Expand All @@ -942,7 +942,7 @@ Uses the DNS protocol to resolve name server records (`NS` records) for the
records available for `hostname` (e.g.
`['ns1.example.com', 'ns2.example.com']`).

### dnsPromises.resolvePtr(hostname)
### `dnsPromises.resolvePtr(hostname)`
<!-- YAML
added: v10.6.0
-->
Expand All @@ -953,7 +953,7 @@ Uses the DNS protocol to resolve pointer records (`PTR` records) for the
`hostname`. On success, the `Promise` is resolved with an array of strings
containing the reply records.

### dnsPromises.resolveSoa(hostname)
### `dnsPromises.resolveSoa(hostname)`
<!-- YAML
added: v10.6.0
-->
Expand Down Expand Up @@ -985,7 +985,7 @@ following properties:
}
```

### dnsPromises.resolveSrv(hostname)
### `dnsPromises.resolveSrv(hostname)`
<!-- YAML
added: v10.6.0
-->
Expand All @@ -1011,7 +1011,7 @@ the following properties:
}
```

### dnsPromises.resolveTxt(hostname)
### `dnsPromises.resolveTxt(hostname)`
<!-- YAML
added: v10.6.0
-->
Expand All @@ -1025,7 +1025,7 @@ of the text records available for `hostname` (e.g.
one record. Depending on the use case, these could be either joined together or
treated separately.

### dnsPromises.reverse(ip)
### `dnsPromises.reverse(ip)`
<!-- YAML
added: v10.6.0
-->
Expand All @@ -1038,7 +1038,7 @@ array of hostnames.
On error, the `Promise` is rejected with an [`Error`][] object, where `err.code`
is one of the [DNS error codes](#dns_error_codes).

### dnsPromises.setServers(servers)
### `dnsPromises.setServers(servers)`
<!-- YAML
added: v10.6.0
-->
Expand Down