From aea02536974a5708ade24dcb20d7c33f7f5ee276 Mon Sep 17 00:00:00 2001 From: Vse Mozhet Byt Date: Tue, 1 Oct 2019 18:57:09 +0300 Subject: [PATCH] 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: https://github.com/nodejs/node/pull/29799 Reviewed-By: Anna Henningsen Reviewed-By: David Carlier Reviewed-By: Ruben Bridgewater Reviewed-By: James M Snell Reviewed-By: Rich Trott Reviewed-By: Trivikram Kamat Reviewed-By: Colin Ihrig --- doc/api/assert.md | 6 +++--- doc/api/events.md | 4 ++-- doc/api/modules.md | 4 ++-- doc/api/repl.md | 4 ++-- doc/api/util.md | 4 ++-- 5 files changed, 11 insertions(+), 11 deletions(-) diff --git a/doc/api/assert.md b/doc/api/assert.md index 09d2aa46c26c96..2c74b6809e1a45 100644 --- a/doc/api/assert.md +++ b/doc/api/assert.md @@ -623,15 +623,15 @@ changes: deprecated and emits a warning. --> +> Stability: 0 - Deprecated: Use `assert.fail([message])` or other assert +> functions instead. + * `actual` {any} * `expected` {any} * `message` {string|Error} * `operator` {string} **Default:** `'!='` * `stackStartFn` {Function} **Default:** `assert.fail` -> Stability: 0 - Deprecated: Use `assert.fail([message])` or other assert -> functions instead. - If `message` is falsy, the error message is set as the values of `actual` and `expected` separated by the provided `operator`. If just the two `actual` and `expected` arguments are provided, `operator` will default to `'!='`. If diff --git a/doc/api/events.md b/doc/api/events.md index 9b22d33e12caa0..608d7d09e04cf0 100644 --- a/doc/api/events.md +++ b/doc/api/events.md @@ -229,11 +229,11 @@ added: v0.9.12 deprecated: v4.0.0 --> +> Stability: 0 - Deprecated: Use [`emitter.listenerCount()`][] instead. + * `emitter` {EventEmitter} The emitter to query * `eventName` {string|symbol} The event name -> Stability: 0 - Deprecated: Use [`emitter.listenerCount()`][] instead. - A class method that returns the number of listeners for the given `eventName` registered on the given `emitter`. diff --git a/doc/api/modules.md b/doc/api/modules.md index 6225f41cad8365..32490cf47f1792 100644 --- a/doc/api/modules.md +++ b/doc/api/modules.md @@ -970,12 +970,12 @@ added: v10.12.0 deprecated: v12.2.0 --> +> Stability: 0 - Deprecated: Please use [`createRequire()`][] instead. + * `filename` {string} Filename to be used to construct the relative require function. * Returns: {require} Require function -> Stability: 0 - Deprecated: Please use [`createRequire()`][] instead. - ```js const { createRequireFromPath } = require('module'); const requireUtil = createRequireFromPath('../src/utils/'); diff --git a/doc/api/repl.md b/doc/api/repl.md index 573fbb6af422a6..d4a207dc493373 100644 --- a/doc/api/repl.md +++ b/doc/api/repl.md @@ -482,12 +482,12 @@ added: v0.8.9 deprecated: v9.0.0 --> +> Stability: 0 - Deprecated. + * `keyword` {string} the potential keyword to parse and execute * `rest` {any} any parameters to the keyword command * Returns: {boolean} -> Stability: 0 - Deprecated. - An internal method used to parse and execute `REPLServer` keywords. Returns `true` if `keyword` is a valid keyword, otherwise `false`. diff --git a/doc/api/util.md b/doc/api/util.md index f00cf9e58c3010..d158fbd1a832d7 100644 --- a/doc/api/util.md +++ b/doc/api/util.md @@ -1766,11 +1766,11 @@ added: v0.7.5 deprecated: v6.0.0 --> +> Stability: 0 - Deprecated: Use [`Object.assign()`] instead. + * `target` {Object} * `source` {Object} -> Stability: 0 - Deprecated: Use [`Object.assign()`] instead. - The `util._extend()` method was never intended to be used outside of internal Node.js modules. The community found and used it anyway.