1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: make RFC references consistent

Browse Source 
Use "RFC 1234" instead of "rfc1234", "RFC1234" or similar variants.

PR-URL: https://github.com/nodejs/node/pull/26727
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
This commit is contained in:
Rich Trott 2019-03-17 21:32:12 -07:00
parent 0a00933921
commit 3e781c5177
4 changed files with 13 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/api/buffer.md
View File

@ -178,10 +178,10 @@ The character encodings currently supported by Node.js include:
* `'base64'` - Base64 encoding. When creating a `Buffer` from a string,
this encoding will also correctly accept "URL and Filename Safe Alphabet" as
specified in [RFC4648, Section 5].
specified in [RFC 4648, Section 5].
* `'latin1'` - A way of encoding the `Buffer` into a one-byte encoded string
(as defined by the IANA in [RFC1345],
(as defined by the IANA in [RFC 1345],
page 63, to be the Latin-1 supplement block and C0/C1 control codes).
* `'binary'` - Alias for `'latin1'`.
@ -2644,8 +2644,8 @@ in UTF-16 code units.
This value may depend on the JS engine that is being used.
[RFC1345]: https://tools.ietf.org/html/rfc1345
[RFC4648, Section 5]: https://tools.ietf.org/html/rfc4648#section-5
[RFC 1345]: https://tools.ietf.org/html/rfc1345
[RFC 4648, Section 5]: https://tools.ietf.org/html/rfc4648#section-5
[WHATWG Encoding Standard]: https://encoding.spec.whatwg.org/
[`ArrayBuffer#slice()`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer/slice
[`ArrayBuffer`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer

14
doc/api/dns.md
View File

@ -112,7 +112,7 @@ added: v0.11.3
* Returns: {string[]}
Returns an array of IP address strings, formatted according to [rfc5952][],
Returns an array of IP address strings, formatted according to [RFC 5952][],
that are currently configured for DNS resolution. A string will include a port
section if a custom port is used.
@ -555,10 +555,10 @@ one of the [DNS error codes][].
<!-- YAML
added: v0.11.3
-->
* `servers` {string[]} array of [rfc5952][] formatted addresses
* `servers` {string[]} array of [RFC 5952][] formatted addresses
Sets the IP address and port of servers to be used when performing DNS
resolution. The `servers` argument is an array of [rfc5952][] formatted
resolution. The `servers` argument is an array of [RFC 5952][] formatted
addresses. If the port is the IANA default DNS port (53) it can be omitted.
```js
@ -647,7 +647,7 @@ added: v10.6.0
* Returns: {string[]}
Returns an array of IP address strings, formatted according to [rfc5952][],
Returns an array of IP address strings, formatted according to [RFC 5952][],
that are currently configured for DNS resolution. A string will include a port
section if a custom port is used.
@ -1008,10 +1008,10 @@ is one of the [DNS error codes](#dns_error_codes).
<!-- YAML
added: v10.6.0
-->
* `servers` {string[]} array of [rfc5952][] formatted addresses
* `servers` {string[]} array of [RFC 5952][] formatted addresses
Sets the IP address and port of servers to be used when performing DNS
resolution. The `servers` argument is an array of [rfc5952][] formatted
resolution. The `servers` argument is an array of [RFC 5952][] formatted
addresses. If the port is the IANA default DNS port (53) it can be omitted.
```js
@ -1147,5 +1147,5 @@ uses. For instance, _they do not use the configuration from `/etc/hosts`_.
[DNS error codes]: #dns_error_codes
[Implementation considerations section]: #dns_implementation_considerations
[RFC 8482]: https://tools.ietf.org/html/rfc8482
[rfc5952]: https://tools.ietf.org/html/rfc5952#section-6
[RFC 5952]: https://tools.ietf.org/html/rfc5952#section-6
[supported `getaddrinfo` flags]: #dns_supported_getaddrinfo_flags

2
doc/api/http.md
View File

@ -2088,7 +2088,7 @@ There are a few special headers that should be noted.
* Sending an 'Expect' header will immediately send the request headers.
Usually, when sending 'Expect: 100-continue', both a timeout and a listener
for the `'continue'` event should be set. See RFC2616 Section 8.2.3 for more
for the `'continue'` event should be set. See RFC 2616 Section 8.2.3 for more
information.
* Sending an Authorization header will override using the `auth` option

2
doc/api/http2.md
View File

@ -3223,7 +3223,7 @@ added: v8.4.0
* {string}
Status message is not supported by HTTP/2 (RFC7540 8.1.2.4). It returns
Status message is not supported by HTTP/2 (RFC 7540 8.1.2.4). It returns
an empty string.
#### response.stream