Skip to content

Commit 2a2971b

Browse files
addaleaxMylesBorins
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 <[email protected]> Reviewed-By: Сковорода Никита Андреевич <[email protected]> Reviewed-By: Michaël Zasso <[email protected]> Reviewed-By: Roman Reiss <[email protected]>
1 parent cadb261 commit 2a2971b

37 files changed

+107
-76
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

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

+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

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

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

+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

@@ -244,7 +244,7 @@ The `'removeListener'` event is emitted *after* a listener is removed.
244244

245245
### EventEmitter.listenerCount(emitter, eventName)
246246

247-
Stability: 0 - Deprecated: Use [`emitter.listenerCount()`][] instead.
247+
> Stability: 0 - Deprecated: Use [`emitter.listenerCount()`][] instead.
248248
249249
A class method that returns the number of listeners for the given `eventName`
250250
registered on the given `emitter`.

‎doc/api/fs.md

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

@@ -476,7 +476,7 @@ added: v0.0.2
476476
deprecated: v1.0.0
477477
-->
478478

479-
Stability: 0 - Deprecated: Use [`fs.stat()`][] or [`fs.access()`][] instead.
479+
> Stability: 0 - Deprecated: Use [`fs.stat()`][] or [`fs.access()`][] instead.
480480
481481
Test whether or not the given path exists by checking with the file system.
482482
Then call the `callback` argument with either true or false. Example:
@@ -499,7 +499,8 @@ added: v0.1.21
499499
deprecated: v1.0.0
500500
-->
501501

502-
Stability: 0 - Deprecated: Use [`fs.statSync()`][] or [`fs.accessSync()`][] instead.
502+
> Stability: 0 - Deprecated: Use [`fs.statSync()`][] or [`fs.accessSync()`][]
503+
> instead.
503504
504505
Synchronous version of [`fs.exists()`][].
505506
Returns `true` if the file exists, `false` otherwise.

‎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

@@ -1274,7 +1274,7 @@ added: v0.1.13
12741274
deprecated: v0.3.6
12751275
-->
12761276

1277-
Stability: 0 - Deprecated: Use [`http.request()`][] instead.
1277+
> Stability: 0 - Deprecated: Use [`http.request()`][] instead.
12781278
12791279
Constructs a new HTTP client. `port` and `host` refer to the server to be
12801280
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
@@ -97,7 +97,7 @@ added: v0.2.0
9797
deprecated: v0.9.7
9898
-->
9999

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

‎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
Provides a few basic operating-system related utility functions.
66

‎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
This module contains utilities for handling and transforming file
66
paths. Almost all these methods perform only string transformations.

‎doc/api/punycode.md

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

3-
Stability: 2 - Stable
3+
> Stability: 2 - Stable
44
55
[Punycode.js][] is bundled with Node.js v0.5.1+. Use `require('punycode')` to
66
access it. (To use it with other Node.js versions, use npm to install the

‎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
To use this module, do `require('readline')`. Readline allows reading of a
66
stream (such as [`process.stdin`][]) on a line-by-line basis.

‎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
A Read-Eval-Print-Loop (REPL) is available both as a standalone program and
66
easily includable in other programs. The REPL provides a way to interactively
@@ -56,7 +56,7 @@ disabled by setting the environment variable `NODE_REPL_HISTORY=""`.
5656

5757
### NODE_REPL_HISTORY_FILE
5858

59-
Stability: 0 - Deprecated: Use `NODE_REPL_HISTORY` instead.
59+
> Stability: 0 - Deprecated: Use `NODE_REPL_HISTORY` instead.
6060
6161
Previously in Node.js/io.js v2.x, REPL history was controlled by using a
6262
`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 implemented by various objects in
66
Node.js. For example a [request to an HTTP server][http-incoming-message] is a

‎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
To use this module, do `require('string_decoder')`. StringDecoder decodes a
66
buffer to a string. It is a simple interface to `buffer.toString()` but provides

‎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
All of the timer functions are globals. You do not need to `require()`
66
this module in order to use them.

‎doc/api/tls.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# TLS (SSL)
22

3-
Stability: 2 - Stable
3+
> Stability: 2 - Stable
44
55
Use `require('tls')` to access this module.
66

@@ -159,7 +159,7 @@ is expensive.
159159

160160
## Class: CryptoStream
161161

162-
Stability: 0 - Deprecated: Use [`tls.TLSSocket`][] instead.
162+
> Stability: 0 - Deprecated: Use [`tls.TLSSocket`][] instead.
163163
164164
This is an encrypted stream.
165165

‎doc/api/tty.md

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

3-
Stability: 2 - Stable
3+
> Stability: 2 - Stable
44
55
The `tty` module houses the `tty.ReadStream` and `tty.WriteStream` classes. In
66
most cases, you will not need to use this module directly.
@@ -95,6 +95,6 @@ terminal.
9595

9696
## tty.setRawMode(mode)
9797

98-
Stability: 0 - Deprecated: Use [tty.ReadStream#setRawMode][] (i.e. process.stdin.setRawMode) instead.
98+
> Stability: 0 - Deprecated: Use [tty.ReadStream#setRawMode][] (i.e. process.stdin.setRawMode) instead.
9999
100100
[tty.ReadStream#setRawMode]: #tty_rs_setrawmode_mode

‎doc/api/url.md

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

3-
Stability: 2 - Stable
3+
> Stability: 2 - Stable
44
55
This module has utilities for URL resolution and parsing.
66
Call `require('url')` to use it.

0 commit comments

Comments
 (0)