Skip to content

Commit e116cf9

Browse files
addaleaxcjihrig
addaleax
authored and
cjihrig
committed
doc: use blockquotes for Stability: markers
Use blockquotes instead of code blocks for stability markers in the docs. Doing that: - Makes the makers appear correctly when viewed e.g. on github. - Allows remark-lint rules like `no-undefined-references` to work properly (#7729). PR-URL: #7757 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Сковорода Никита Андреевич <chalkerx@gmail.com> Reviewed-By: Michaël Zasso <mic.besace@gmail.com> Reviewed-By: Roman Reiss <me@silverwind.io> Conflicts: doc/api/punycode.md
1 parent c934f51 commit e116cf9

36 files changed

+125
-90
lines changed

‎doc/api/assert.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Assert
22

3-
Stability: 3 - Locked
3+
> Stability: 3 - Locked
44
55
The `assert` module provides a simple set of assertion tests that can be used to
66
test invariants. The module is intended for internal use by Node.js, but can be

‎doc/api/buffer.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Buffer
22

3-
Stability: 2 - Stable
3+
> Stability: 2 - Stable
44
55
Prior to the introduction of [`TypedArray`] in ECMAScript 2015 (ES6), the
66
JavaScript language had no mechanism for reading or manipulating streams
@@ -300,7 +300,7 @@ It can be constructed in a variety of ways.
300300
deprecated: v6.0.0
301301
-->
302302

303-
Stability: 0 - Deprecated: Use [`Buffer.from(array)`] instead.
303+
> Stability: 0 - Deprecated: Use [`Buffer.from(array)`] instead.
304304
305305
* `array` {Array} An array of bytes to copy from
306306

@@ -318,7 +318,7 @@ const buf = new Buffer([0x62, 0x75, 0x66, 0x66, 0x65, 0x72]);
318318
deprecated: v6.0.0
319319
-->
320320

321-
Stability: 0 - Deprecated: Use [`Buffer.from(buffer)`] instead.
321+
> Stability: 0 - Deprecated: Use [`Buffer.from(buffer)`] instead.
322322
323323
* `buffer` {Buffer} An existing `Buffer` to copy data from
324324

@@ -344,9 +344,9 @@ console.log(buf2.toString());
344344
deprecated: v6.0.0
345345
-->
346346

347-
Stability: 0 - Deprecated: Use
348-
[`Buffer.from(arrayBuffer[, byteOffset [, length]])`][`Buffer.from(arrayBuffer)`]
349-
instead.
347+
> Stability: 0 - Deprecated: Use
348+
> [`Buffer.from(arrayBuffer[, byteOffset [, length]])`][`Buffer.from(arrayBuffer)`]
349+
> instead.
350350
351351
* `arrayBuffer` {ArrayBuffer} The `.buffer` property of a [`TypedArray`] or
352352
[`ArrayBuffer`]
@@ -387,8 +387,8 @@ console.log(buf);
387387
deprecated: v6.0.0
388388
-->
389389

390-
Stability: 0 - Deprecated: Use [`Buffer.alloc()`] instead (also see
391-
[`Buffer.allocUnsafe()`]).
390+
> Stability: 0 - Deprecated: Use [`Buffer.alloc()`] instead (also see
391+
> [`Buffer.allocUnsafe()`]).
392392
393393
* `size` {Integer} The desired length of the new `Buffer`
394394

@@ -420,8 +420,8 @@ console.log(buf);
420420
deprecated: v6.0.0
421421
-->
422422

423-
Stability: 0 - Deprecated:
424-
Use [`Buffer.from(string[, encoding])`][`Buffer.from(string)`] instead.
423+
> Stability: 0 - Deprecated:
424+
> Use [`Buffer.from(string[, encoding])`][`Buffer.from(string)`] instead.
425425
426426
* `string` {String} String to encode
427427
* `encoding` {String} The encoding of `string`. **Default:** `'utf8'`
@@ -2309,7 +2309,7 @@ On 64-bit architectures, this value is `(2^31)-1` (~2GB).
23092309
deprecated: v6.0.0
23102310
-->
23112311

2312-
Stability: 0 - Deprecated: Use [`Buffer.allocUnsafeSlow()`] instead.
2312+
> Stability: 0 - Deprecated: Use [`Buffer.allocUnsafeSlow()`] instead.
23132313
23142314
Returns an un-pooled `Buffer`.
23152315

@@ -2349,7 +2349,7 @@ has observed undue memory retention in their applications.
23492349
deprecated: v6.0.0
23502350
-->
23512351

2352-
Stability: 0 - Deprecated: Use [`Buffer.allocUnsafeSlow()`] instead.
2352+
> Stability: 0 - Deprecated: Use [`Buffer.allocUnsafeSlow()`] instead.
23532353
23542354
* `size` {Integer} The desired length of the new `SlowBuffer`
23552355

‎doc/api/child_process.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Child Process
22

3-
Stability: 2 - Stable
3+
> Stability: 2 - Stable
44
55
The `child_process` module provides the ability to spawn child processes in
66
a manner that is similar, but not identical, to popen(3). This capability

‎doc/api/cluster.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Cluster
22

3-
Stability: 2 - Stable
3+
> Stability: 2 - Stable
44
55
A single instance of Node.js runs in a single thread. To take advantage of
66
multi-core systems the user will sometimes want to launch a cluster of Node.js
@@ -395,7 +395,7 @@ if (cluster.isMaster) {
395395

396396
### worker.suicide
397397

398-
Stability: 0 - Deprecated: Use [`worker.exitedAfterDisconnect`][] instead.
398+
> Stability: 0 - Deprecated: Use [`worker.exitedAfterDisconnect`][] instead.
399399
400400
An alias to [`worker.exitedAfterDisconnect`][].
401401

‎doc/api/console.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Console
22

3-
Stability: 2 - Stable
3+
> Stability: 2 - Stable
44
55
The `console` module provides a simple debugging console that is similar to the
66
JavaScript console mechanism provided by web browsers.

‎doc/api/crypto.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Crypto
22

3-
Stability: 2 - Stable
3+
> Stability: 2 - Stable
44
55
The `crypto` module provides cryptographic functionality that includes a set of
66
wrappers for OpenSSL's hash, HMAC, cipher, decipher, sign and verify functions.
@@ -510,7 +510,7 @@ public point (key) is also generated and set in the ECDH object.
510510

511511
### ecdh.setPublicKey(public_key[, encoding])
512512

513-
Stability: 0 - Deprecated
513+
> Stability: 0 - Deprecated
514514
515515
Sets the EC Diffie-Hellman public key. Key encoding can be `'latin1'`,
516516
`'hex'` or `'base64'`. If `encoding` is provided `public_key` is expected to
@@ -918,7 +918,7 @@ The `key` is the raw key used by the `algorithm` and `iv` is an
918918

919919
### crypto.createCredentials(details)
920920

921-
Stability: 0 - Deprecated: Use [`tls.createSecureContext()`][] instead.
921+
> Stability: 0 - Deprecated: Use [`tls.createSecureContext()`][] instead.
922922
923923
The `crypto.createCredentials()` method is a deprecated alias for creating
924924
and returning a `tls.SecureContext` object. The `crypto.createCredentials()`

‎doc/api/debugger.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Debugger
22

3-
Stability: 2 - Stable
3+
> Stability: 2 - Stable
44
55
<!-- type=misc -->
66

‎doc/api/dgram.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# UDP / Datagram Sockets
22

3-
Stability: 2 - Stable
3+
> Stability: 2 - Stable
44
55
<!-- name=dgram -->
66

‎doc/api/dns.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# DNS
22

3-
Stability: 2 - Stable
3+
> Stability: 2 - Stable
44
55
The `dns` module contains functions belonging to two different categories:
66

‎doc/api/documentation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ Please do not suggest API changes in this area; they will be refused.
6464

6565
## JSON Output
6666

67-
Stability: 1 - Experimental
67+
> Stability: 1 - Experimental
6868
6969
Every HTML file in the markdown has a corresponding JSON file with the
7070
same data.

0 commit comments

Comments
 (0)