Skip to content

Commit

Permalink
doc: harmonize changes list ordering
Browse files Browse the repository at this point in the history
Refs: nodejs/remark-preset-lint-node#139

PR-URL: #35454
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ujjwal Sharma <ryzokuken@disroot.org>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Khaidi Chu <i@2333.moe>
Reviewed-By: Michael Dawson <midawson@redhat.com>
  • Loading branch information
aduh95 authored and MylesBorins committed Oct 14, 2020
1 parent 8cacca0 commit 62755b6
Show file tree
Hide file tree
Showing 13 changed files with 103 additions and 101 deletions.
6 changes: 3 additions & 3 deletions doc/api/crypto.md
Expand Up @@ -840,13 +840,13 @@ console.log(uncompressedKey === ecdh.getPublicKey('hex'));
<!-- YAML
added: v0.11.14
changes:
- version: v6.0.0
pr-url: https://github.com/nodejs/node/pull/5522
description: The default `inputEncoding` changed from `binary` to `utf8`.
- version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/16849
description: Changed error format to better support invalid public key
error.
- version: v6.0.0
pr-url: https://github.com/nodejs/node/pull/5522
description: The default `inputEncoding` changed from `binary` to `utf8`.
-->

* `otherPublicKey` {string | Buffer | TypedArray | DataView}
Expand Down
18 changes: 9 additions & 9 deletions doc/api/dgram.md
Expand Up @@ -409,6 +409,9 @@ changes:
- version: v14.5.0
pr-url: https://github.com/nodejs/node/pull/22413
description: The `msg` parameter can now be any `TypedArray` or `DataView`.
- version: v12.0.0
pr-url: https://github.com/nodejs/node/pull/26871
description: Added support for sending data on connected sockets.
- version: v8.0.0
pr-url: https://github.com/nodejs/node/pull/11985
description: The `msg` parameter can be an `Uint8Array` now.
Expand All @@ -423,9 +426,6 @@ changes:
pr-url: https://github.com/nodejs/node/pull/4374
description: The `msg` parameter can be an array now. Also, the `offset`
and `length` parameters are optional now.
- version: v12.0.0
pr-url: https://github.com/nodejs/node/pull/26871
description: Added support for sending data on connected sockets.
-->

* `msg` {Buffer|TypedArray|DataView|string|Array} Message to be sent.
Expand Down Expand Up @@ -733,16 +733,16 @@ chained.
<!-- YAML
added: v0.11.13
changes:
- version: v8.6.0
pr-url: https://github.com/nodejs/node/pull/14560
description: The `lookup` option is supported.
- version: v11.4.0
pr-url: https://github.com/nodejs/node/pull/23798
description: The `ipv6Only` option is supported.
- version: v8.7.0
pr-url: https://github.com/nodejs/node/pull/13623
description: The `recvBufferSize` and `sendBufferSize` options are
supported now.
- version: v11.4.0
pr-url: https://github.com/nodejs/node/pull/23798
description: The `ipv6Only` option is supported.
- version: v8.6.0
pr-url: https://github.com/nodejs/node/pull/14560
description: The `lookup` option is supported.
-->

* `options` {Object} Available options are:
Expand Down
58 changes: 29 additions & 29 deletions doc/api/fs.md
Expand Up @@ -1919,12 +1919,12 @@ If `options` is a string, then it specifies the encoding.
## `fs.exists(path, callback)`
<!-- YAML
added: v0.0.2
deprecated: v1.0.0
changes:
- version: v7.6.0
pr-url: https://github.com/nodejs/node/pull/10739
description: The `path` parameter can be a WHATWG `URL` object using
`file:` protocol. Support is currently still *experimental*.
deprecated: v1.0.0
-->

> Stability: 0 - Deprecated: Use [`fs.stat()`][] or [`fs.access()`][] instead.
Expand Down Expand Up @@ -2154,6 +2154,10 @@ Synchronous fdatasync(2). Returns `undefined`.
<!-- YAML
added: v0.1.95
changes:
- version: v10.5.0
pr-url: https://github.com/nodejs/node/pull/20220
description: Accepts an additional `options` object to specify whether
the numeric values returned should be bigint.
- version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/12562
description: The `callback` parameter is no longer optional. Not passing
Expand All @@ -2162,10 +2166,6 @@ changes:
pr-url: https://github.com/nodejs/node/pull/7897
description: The `callback` parameter is no longer optional. Not passing
it will emit a deprecation warning with id DEP0013.
- version: v10.5.0
pr-url: https://github.com/nodejs/node/pull/20220
description: Accepts an additional `options` object to specify whether
the numeric values returned should be bigint.
-->

* `fd` {integer}
Expand Down Expand Up @@ -2507,6 +2507,10 @@ Synchronous link(2). Returns `undefined`.
<!-- YAML
added: v0.1.30
changes:
- version: v10.5.0
pr-url: https://github.com/nodejs/node/pull/20220
description: Accepts an additional `options` object to specify whether
the numeric values returned should be bigint.
- version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/12562
description: The `callback` parameter is no longer optional. Not passing
Expand All @@ -2519,10 +2523,6 @@ changes:
pr-url: https://github.com/nodejs/node/pull/7897
description: The `callback` parameter is no longer optional. Not passing
it will emit a deprecation warning with id DEP0013.
- version: v10.5.0
pr-url: https://github.com/nodejs/node/pull/20220
description: Accepts an additional `options` object to specify whether
the numeric values returned should be bigint.
-->

* `path` {string|Buffer|URL}
Expand All @@ -2542,14 +2542,14 @@ not the file that it refers to.
<!-- YAML
added: v0.1.30
changes:
- version: v7.6.0
pr-url: https://github.com/nodejs/node/pull/10739
description: The `path` parameter can be a WHATWG `URL` object using `file:`
protocol. Support is currently still *experimental*.
- version: v10.5.0
pr-url: https://github.com/nodejs/node/pull/20220
description: Accepts an additional `options` object to specify whether
the numeric values returned should be bigint.
- version: v7.6.0
pr-url: https://github.com/nodejs/node/pull/10739
description: The `path` parameter can be a WHATWG `URL` object using `file:`
protocol. Support is currently still *experimental*.
-->

* `path` {string|Buffer|URL}
Expand Down Expand Up @@ -3632,6 +3632,10 @@ utility). Returns `undefined`.
<!-- YAML
added: v0.0.2
changes:
- version: v10.5.0
pr-url: https://github.com/nodejs/node/pull/20220
description: Accepts an additional `options` object to specify whether
the numeric values returned should be bigint.
- version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/12562
description: The `callback` parameter is no longer optional. Not passing
Expand All @@ -3644,10 +3648,6 @@ changes:
pr-url: https://github.com/nodejs/node/pull/7897
description: The `callback` parameter is no longer optional. Not passing
it will emit a deprecation warning with id DEP0013.
- version: v10.5.0
pr-url: https://github.com/nodejs/node/pull/20220
description: Accepts an additional `options` object to specify whether
the numeric values returned should be bigint.
-->

* `path` {string|Buffer|URL}
Expand Down Expand Up @@ -3745,14 +3745,14 @@ Stats {
<!-- YAML
added: v0.1.21
changes:
- version: v7.6.0
pr-url: https://github.com/nodejs/node/pull/10739
description: The `path` parameter can be a WHATWG `URL` object using `file:`
protocol. Support is currently still *experimental*.
- version: v10.5.0
pr-url: https://github.com/nodejs/node/pull/20220
description: Accepts an additional `options` object to specify whether
the numeric values returned should be bigint.
- version: v7.6.0
pr-url: https://github.com/nodejs/node/pull/10739
description: The `path` parameter can be a WHATWG `URL` object using `file:`
protocol. Support is currently still *experimental*.
-->

* `path` {string|Buffer|URL}
Expand All @@ -3767,15 +3767,15 @@ Synchronous stat(2).
<!-- YAML
added: v0.1.31
changes:
- version: v12.0.0
pr-url: https://github.com/nodejs/node/pull/23724
description: If the `type` argument is left undefined, Node will autodetect
`target` type and automatically select `dir` or `file`.
- version: v7.6.0
pr-url: https://github.com/nodejs/node/pull/10739
description: The `target` and `path` parameters can be WHATWG `URL` objects
using `file:` protocol. Support is currently still
*experimental*.
- version: v12.0.0
pr-url: https://github.com/nodejs/node/pull/23724
description: If the `type` argument is left undefined, Node will autodetect
`target` type and automatically select `dir` or `file`.
-->

* `target` {string|Buffer|URL}
Expand Down Expand Up @@ -3815,15 +3815,15 @@ example/
<!-- YAML
added: v0.1.31
changes:
- version: v12.0.0
pr-url: https://github.com/nodejs/node/pull/23724
description: If the `type` argument is left undefined, Node will autodetect
`target` type and automatically select `dir` or `file`.
- version: v7.6.0
pr-url: https://github.com/nodejs/node/pull/10739
description: The `target` and `path` parameters can be WHATWG `URL` objects
using `file:` protocol. Support is currently still
*experimental*.
- version: v12.0.0
pr-url: https://github.com/nodejs/node/pull/23724
description: If the `type` argument is left undefined, Node will autodetect
`target` type and automatically select `dir` or `file`.
-->

* `target` {string|Buffer|URL}
Expand Down
18 changes: 9 additions & 9 deletions doc/api/http.md
Expand Up @@ -1040,20 +1040,20 @@ not be emitted.
<!-- YAML
added: v0.1.94
changes:
- version: v6.0.0
pr-url: https://github.com/nodejs/node/pull/4557
description: The default action of calling `.destroy()` on the `socket`
will no longer take place if there are listeners attached
for `'clientError'`.
- version: v12.0.0
pr-url: https://github.com/nodejs/node/pull/25605
description: The default behavior will return a 431 Request Header
Fields Too Large if a HPE_HEADER_OVERFLOW error occurs.
- version: v9.4.0
pr-url: https://github.com/nodejs/node/pull/17672
description: The `rawPacket` is the current buffer that just parsed. Adding
this buffer to the error object of `'clientError'` event is to
make it possible that developers can log the broken packet.
- version: v12.0.0
pr-url: https://github.com/nodejs/node/pull/25605
description: The default behavior will return a 431 Request Header
Fields Too Large if a HPE_HEADER_OVERFLOW error occurs.
- version: v6.0.0
pr-url: https://github.com/nodejs/node/pull/4557
description: The default action of calling `.destroy()` on the `socket`
will no longer take place if there are listeners attached
for `'clientError'`.
-->

* `exception` {Error}
Expand Down
8 changes: 4 additions & 4 deletions doc/api/http2.md
Expand Up @@ -2075,6 +2075,10 @@ changes:
pr-url: https://github.com/nodejs/node/pull/27782
description: The `options` parameter now supports `net.createServer()`
options.
- version: v9.6.0
pr-url: https://github.com/nodejs/node/pull/15752
description: Added the `Http1IncomingMessage` and `Http1ServerResponse`
option.
- version: v8.9.3
pr-url: https://github.com/nodejs/node/pull/17105
description: Added the `maxOutstandingPings` option with a default limit of
Expand All @@ -2083,10 +2087,6 @@ changes:
pr-url: https://github.com/nodejs/node/pull/16676
description: Added the `maxHeaderListPairs` option with a default limit of
128 header pairs.
- version: v9.6.0
pr-url: https://github.com/nodejs/node/pull/15752
description: Added the `Http1IncomingMessage` and `Http1ServerResponse`
option.
-->

* `options` {Object}
Expand Down
6 changes: 3 additions & 3 deletions doc/api/https.md
Expand Up @@ -13,13 +13,13 @@ separate module.
<!-- YAML
added: v0.4.5
changes:
- version: v5.3.0
pr-url: https://github.com/nodejs/node/pull/4252
description: support `0` `maxCachedSessions` to disable TLS session caching.
- version: v2.5.0
pr-url: https://github.com/nodejs/node/pull/2228
description: parameter `maxCachedSessions` added to `options` for TLS
sessions reuse.
- version: v5.3.0
pr-url: https://github.com/nodejs/node/pull/4252
description: support `0` `maxCachedSessions` to disable TLS session caching.
-->

An [`Agent`][] object for HTTPS similar to [`http.Agent`][]. See
Expand Down
20 changes: 10 additions & 10 deletions doc/api/packages.md
Expand Up @@ -882,24 +882,24 @@ as ES modules and `.cjs` files are always treated as CommonJS.
added: v12.7.0
changes:
- version:
- v13.2.0
- v14.13.0
pr-url: https://github.com/nodejs/node/pull/34718
description: Add support for `"exports"` patterns.
- version:
- v13.7.0
- v12.16.0
pr-url: https://github.com/nodejs/node/pull/29978
description: Implement conditional exports.
pr-url: https://github.com/nodejs/node/pull/31008
description: Implement logical conditional exports ordering.
- version:
- v13.7.0
- v12.16.0
pr-url: https://github.com/nodejs/node/pull/31001
description: Remove the `--experimental-conditional-exports` option.
- version:
- v13.7.0
- v13.2.0
- v12.16.0
pr-url: https://github.com/nodejs/node/pull/31008
description: Implement logical conditional exports ordering.
- version:
- v14.13.0
pr-url: https://github.com/nodejs/node/pull/34718
description: Add support for `"exports"` patterns.
pr-url: https://github.com/nodejs/node/pull/29978
description: Implement conditional exports.
-->

* Type: {Object} | {string} | {string[]}
Expand Down
6 changes: 3 additions & 3 deletions doc/api/process.md
Expand Up @@ -2498,12 +2498,12 @@ To get the version string without the prepended _v_, use
<!-- YAML
added: v0.2.0
changes:
- version: v4.2.0
pr-url: https://github.com/nodejs/node/pull/3102
description: The `icu` property is now supported.
- version: v9.0.0
pr-url: https://github.com/nodejs/node/pull/15785
description: The `v8` property now includes a Node.js specific suffix.
- version: v4.2.0
pr-url: https://github.com/nodejs/node/pull/3102
description: The `icu` property is now supported.
-->

* {Object}
Expand Down
12 changes: 6 additions & 6 deletions doc/api/stream.md
Expand Up @@ -1645,15 +1645,15 @@ const cleanup = finished(rs, (err) => {
<!-- YAML
added: v10.0.0
changes:
- version: v13.10.0
pr-url: https://github.com/nodejs/node/pull/31223
description: Add support for async generators.
- version: v14.0.0
pr-url: https://github.com/nodejs/node/pull/32158
description: The `pipeline(..., cb)` will wait for the `'close'` event
before invoking the callback. The implementation tries to
detect legacy streams and only apply this behavior to streams
which are expected to emit `'close'`.
- version: v13.10.0
pr-url: https://github.com/nodejs/node/pull/31223
description: Add support for async generators.
-->

* `streams` {Stream[]|Iterable[]|AsyncIterable[]|Function[]}
Expand Down Expand Up @@ -2201,15 +2201,15 @@ constructor and implement the [`readable._read()`][] method.
#### `new stream.Readable([options])`
<!-- YAML
changes:
- version: v14.0.0
pr-url: https://github.com/nodejs/node/pull/30623
description: Change `autoDestroy` option default to `true`.
- version:
- v11.2.0
- v10.16.0
pr-url: https://github.com/nodejs/node/pull/22795
description: Add `autoDestroy` option to automatically `destroy()` the
stream when it emits `'end'` or errors.
- version: v14.0.0
pr-url: https://github.com/nodejs/node/pull/30623
description: Change `autoDestroy` option default to `true`.
-->

* `options` {Object}
Expand Down

0 comments on commit 62755b6

Please sign in to comment.