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 <[email protected]> Reviewed-By: Сковорода Никита Андреевич <[email protected]> Reviewed-By: Michaël Zasso <[email protected]> Reviewed-By: Roman Reiss <[email protected]> Conflicts: doc/api/punycode.md
1 parent c934f51 commit e116cf9

36 files changed

+125
-90
lines changed

‎doc/api/assert.md

+1-1
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

+12-12
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

+1-1
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

+2-2
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

+1-1
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

+3-3
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

+1-1
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

+1-1
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

+1-1
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

+1-1
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.

‎doc/api/domain.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Domain
22

3-
Stability: 0 - Deprecated
3+
> Stability: 0 - Deprecated
44
55
**This module is pending deprecation**. Once a replacement API has been
66
finalized, this module will be fully deprecated. Most end users should
@@ -436,8 +436,8 @@ without exiting the domain.
436436

437437
### domain.dispose()
438438

439-
Stability: 0 - Deprecated. Please recover from failed IO actions
440-
explicitly via error event handlers set on the domain.
439+
> Stability: 0 - Deprecated. Please recover from failed IO actions
440+
> explicitly via error event handlers set on the domain.
441441
442442
Once `dispose` has been called, the domain will no longer be used by callbacks
443443
bound into the domain via `run`, `bind`, or `intercept`, and a `'dispose'` event

‎doc/api/events.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Events
22

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

@@ -222,7 +222,7 @@ The `'removeListener'` event is emitted *after* the `listener` is removed.
222222

223223
### EventEmitter.listenerCount(emitter, eventName)
224224

225-
Stability: 0 - Deprecated: Use [`emitter.listenerCount()`][] instead.
225+
> Stability: 0 - Deprecated: Use [`emitter.listenerCount()`][] instead.
226226
227227
A class method that returns the number of listeners for the given `eventName`
228228
registered on the given `emitter`.

‎doc/api/fs.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# File System
22

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

@@ -584,7 +584,7 @@ added: v0.0.2
584584
deprecated: v1.0.0
585585
-->
586586

587-
Stability: 0 - Deprecated: Use [`fs.stat()`][] or [`fs.access()`][] instead.
587+
> Stability: 0 - Deprecated: Use [`fs.stat()`][] or [`fs.access()`][] instead.
588588
589589
* `path` {String | Buffer}
590590
* `callback` {Function}
@@ -610,8 +610,8 @@ added: v0.1.21
610610
deprecated: v1.0.0
611611
-->
612612

613-
Stability: 0 - Deprecated: Use [`fs.statSync()`][] or [`fs.accessSync()`][]
614-
instead.
613+
> Stability: 0 - Deprecated: Use [`fs.statSync()`][] or [`fs.accessSync()`][]
614+
> instead.
615615
616616
* `path` {String | Buffer}
617617

‎doc/api/globals.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,7 @@ Error.
155155

156156
### require.extensions
157157

158-
Stability: 0 - Deprecated
158+
> Stability: 0 - Deprecated
159159
160160
* {Object}
161161

‎doc/api/http.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# HTTP
22

3-
Stability: 2 - Stable
3+
> Stability: 2 - Stable
44
55
To use the HTTP server and client one must `require('http')`.
66

@@ -1331,7 +1331,7 @@ added: v0.1.13
13311331
deprecated: v0.3.6
13321332
-->
13331333

1334-
Stability: 0 - Deprecated: Use [`http.request()`][] instead.
1334+
> Stability: 0 - Deprecated: Use [`http.request()`][] instead.
13351335
13361336
Constructs a new HTTP client. `port` and `host` refer to the server to be
13371337
connected to.

‎doc/api/https.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# HTTPS
22

3-
Stability: 2 - Stable
3+
> Stability: 2 - Stable
44
55
HTTPS is the HTTP protocol over TLS/SSL. In Node.js this is implemented as a
66
separate module.

‎doc/api/modules.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Modules
22

3-
Stability: 3 - Locked
3+
> Stability: 3 - Locked
44
55
<!--name=module-->
66

‎doc/api/net.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# net
22

3-
Stability: 2 - Stable
3+
> Stability: 2 - Stable
44
55
The `net` module provides you with an asynchronous network wrapper. It contains
66
functions for creating both servers and clients (called streams). You can include
@@ -98,7 +98,7 @@ added: v0.2.0
9898
deprecated: v0.9.7
9999
-->
100100

101-
Stability: 0 - Deprecated: Use [`server.getConnections()`][] instead.
101+
> Stability: 0 - Deprecated: Use [`server.getConnections()`][] instead.
102102
103103
The number of concurrent connections on the server.
104104

‎doc/api/os.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# OS
22

3-
Stability: 2 - Stable
3+
> Stability: 2 - Stable
44
55
The `os` module provides a number of operating system-related utility methods.
66
It can be accessed using:

‎doc/api/path.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Path
22

3-
Stability: 2 - Stable
3+
> Stability: 2 - Stable
44
55
The `path` module provides utilities for working with file and directory paths.
66
It can be accessed using:

‎doc/api/punycode.md

+6-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
11
# punycode
22

3-
Stability: 2 - Stable
3+
> Stability: 0 - Deprecated
4+
5+
**The version of the punycode module bundled in Node.js is being deprecated**.
6+
In a future major version of Node.js this module will be removed. Users
7+
currently depending on the `punycode` module should switch to using the
8+
userland-provided [Punycode.js][] module instead.
49

510
The `punycode` module is a bundled version of the [Punycode.js][] module. It
611
can be accessed using:

‎doc/api/querystring.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Query String
22

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

‎doc/api/readline.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Readline
22

3-
Stability: 2 - Stable
3+
> Stability: 2 - Stable
44
55
The `readline` module provides an interface for reading data from a [Readable][]
66
stream (such as [`process.stdin`]) one line at a time. It can be accessed using:

‎doc/api/repl.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# REPL
22

3-
Stability: 2 - Stable
3+
> Stability: 2 - Stable
44
55
The `repl` module provides a Read-Eval-Print-Loop (REPL) implementation that
66
is available both as a standalone program or includable in other applications.
@@ -444,7 +444,7 @@ added: v2.0.0
444444
deprecated: v3.0.0
445445
-->
446446

447-
Stability: 0 - Deprecated: Use `NODE_REPL_HISTORY` instead.
447+
> Stability: 0 - Deprecated: Use `NODE_REPL_HISTORY` instead.
448448
449449
Previously in Node.js/io.js v2.x, REPL history was controlled by using a
450450
`NODE_REPL_HISTORY_FILE` environment variable, and the history was saved in JSON

‎doc/api/stream.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Stream
22

3-
Stability: 2 - Stable
3+
> Stability: 2 - Stable
44
55
A stream is an abstract interface for working with streaming data in Node.js.
66
The `stream` module provides a base API that makes it easy to build objects

‎doc/api/string_decoder.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# StringDecoder
22

3-
Stability: 2 - Stable
3+
> Stability: 2 - Stable
44
55
The `string_decoder` module provides an API for decoding `Buffer` objects into
66
strings in a manner that preserves encoded multi-byte UTF-8 and UTF-16

‎doc/api/timers.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Timers
22

3-
Stability: 3 - Locked
3+
> Stability: 3 - Locked
44
55
The `timer` module exposes a global API for scheduling functions to
66
be called at some future period of time. Because the timer functions are

0 commit comments

Comments
 (0)