FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

doc: use blockquotes for Stability: markers · nodejs/node@2a2971b · GitHub

/ node Public

Commit 2a2971b

Browse files
addaleax
authored and
MylesBorins
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>
1 parent cadb261 commit 2a2971b

37 files changed

Lines changed: 107 additions & 76 deletions

‎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: 1 addition & 1 deletion
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

‎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: 1 addition & 1 deletion
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

‎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.
@@ -495,7 +495,7 @@ public point (key) is also generated and set in the ECDH object.
495495

496496
### ecdh.setPublicKey(public_key[, encoding])
497497

498-
Stability: 0 - Deprecated
498+
> Stability: 0 - Deprecated
499499
500500
Sets the EC Diffie-Hellman public key. Key encoding can be `'binary'`,
501501
`'hex'` or `'base64'`. If `encoding` is provided `public_key` is expected to
@@ -892,7 +892,7 @@ The `key` is the raw key used by the `algorithm` and `iv` is an
892892

893893
### crypto.createCredentials(details)
894894

895-
Stability: 0 - Deprecated: Use [`tls.createSecureContext()`][] instead.
895+
> Stability: 0 - Deprecated: Use [`tls.createSecureContext()`][] instead.
896896
897897
The `crypto.createCredentials()` method is a deprecated alias for creating
898898
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)
Back | FazBrowse Home | New Git URL