Skip to content
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

tools,doc: standardize RFC name formatting #26727

Closed
wants to merge 2 commits into from
Closed

tools,doc: standardize RFC name formatting #26727

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e96ec2f
doc: make RFC references consistent
Trott Mar 18, 2019
9361bbf
tools: update lint-md.js to lint rfc name format
Trott Mar 18, 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
8 changes: 4 additions & 4 deletions doc/api/buffer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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'`.
Expand Down Expand Up @@ -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
Expand Down
14 changes: 7 additions & 7 deletions doc/api/dns.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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.

Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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 changes: 1 addition & 1 deletion doc/api/http.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion doc/api/http2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion tools/lint-md.js
View file
Open in desktop

Large diffs are not rendered by default.

14 changes: 7 additions & 7 deletions tools/node-lint-md-cli-rollup/package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion tools/node-lint-md-cli-rollup/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
"markdown-extensions": "^1.1.1",
"remark": "^10.0.1",
"remark-lint": "^6.0.4",
"remark-preset-lint-node": "^1.4.0",
"remark-preset-lint-node": "^1.6.0",
"unified-args": "^6.0.0",
"unified-engine": "^5.1.0"
},
Expand Down