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>
nodejs · Oct 3, 2019 · d5882a9 · d5882a9
1 parent 4fa1744
commit d5882a9
Show file tree

Hide file tree

Showing 6 changed files with 13 additions and 13 deletions.
diff --git a/doc/api/assert.md b/doc/api/assert.md
@@ -624,15 +624,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
@@ -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/http.md b/doc/api/http.md
@@ -1169,10 +1169,10 @@ added: v0.3.0
 deprecated: REPLACEME
 -->
 
-* {net.Socket}
-
 > Stability: 0 - Deprecated. Use [`response.socket`][].
 
+* {net.Socket}
+
 See [`response.socket`][].
 
 ### response.end([data[, encoding]][, callback])

diff --git 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
@@ -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
@@ -1769,11 +1769,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.