8000 doc: unify place of stability notes · nodejs/node@aea0253 · GitHub
[go: up one dir, main page]
Skip to content

Commit aea0253

Browse files
vsemozhetbytBridgeAR
vsemozhetbyt
authored and
BridgeAR
committed
doc: unify place of stability notes
In most cases, stability note is the first info in a doc section after YAML. This PR makes it consistent across all docs, as this info seems the most relevant for a reader. PR-URL: #29799 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: David Carlier <devnexen@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
1 parent 320f649 commit aea0253

File tree

5 files changed

+11
-11
lines changed
Open diff view settings

5 files changed

+11
-11
lines changed

‎doc/api/assert.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -623,15 +623,15 @@ changes:
623623
deprecated and emits a warning.
624624
-->
625625

626+
> Stability: 0 - Deprecated: Use `assert.fail([message])` or other assert
627+
> functions instead.
628+
626629
* `actual` {any}
627630
* `expected` {any}
628631
* `message` {string|Error}
629632
* `operator` {string} **Default:** `'!='`
630633
* `stackStartFn` {Function} **Default:** `assert.fail`
631634

632-
> Stability: 0 - Deprecated: Use `assert.fail([message])` or other assert
633-
> functions instead.
634-
635635
If `message` is falsy, the error message is set as the values of `actual` and
636636
`expected` separated by the provided `operator`. If just the two `actual` and
637637
`expected` arguments are provided, `operator` will default to `'!='`. If

‎doc/api/events.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -229,11 +229,11 @@ added: v0.9.12
229229
deprecated: v4.0.0
230230
-->
231231

232+
> Stability: 0 - Deprecated: Use [`emitter.listenerCount()`][] instead.
233+
232234
* `emitter` {EventEmitter} The emitter to query
233235
* `eventName` {string|symbol} The event name
234236

235-
> Stability: 0 - Deprecated: Use [`emitter.listenerCount()`][] instead.
236-
237237
A class method that returns the number of listeners for the given `eventName`
238238
registered on the given `emitter`.
239239

‎doc/api/modules.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -970,12 +970,12 @@ added: v10.12.0
970970
deprecated: v12.2.0
971971
-->
972972
973+
> Stability: 0 - Deprecated: Please use [`createRequire()`][] instead.
974+
973975
* `filename` {string} Filename to be used to construct the relative require
974976
function.
975977
* Returns: {require} Require function
976978
977-
> Stability: 0 - Deprecated: Please use [`createRequire()`][] instead.
978-
979979
```js
980980
const { createRequireFromPath } = require('module');
981981
const requireUtil = createRequireFromPath('../src/utils/');

‎doc/api/repl.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -482,12 +482,12 @@ added: v0.8.9
482482
deprecated: v9.0.0
483483
-->
484484

485+
> Stability: 0 - Deprecated.
486+
485487
* `keyword` {string} the potential keyword to parse and execute
486488
* `rest` {any} any parameters to the keyword command
487489
* Returns: {boolean}
488490

489-
> Stability: 0 - Deprecated.
490-
491491
An internal method used to parse and execute `REPLServer` keywords.
492492
Returns `true` if `keyword` is a valid keyword, otherwise `false`.
493493

‎doc/api/util.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1766,11 +1766,11 @@ added: v0.7.5
17661766
deprecated: v6.0.0
17671767
-->
17681768

1769+
> Stability: 0 - Deprecated: Use [`Object.assign()`] instead.
1770+
17691771
* `target` {Object}
17701772
* `source` {Object}
17711773

1772-
> Stability: 0 - Deprecated: Use [`Object.assign()`] instead.
1773-
17741774
The `util._extend()` method was never intended to be used outside of internal
17751775
Node.js modules. The community found and used it anyway.
17761776

0 commit comments

Comments
 (0)
0