Skip to content

doc: use blockquotes for Stability: markers #7757

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion doc/api/assert.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Assert

Stability: 3 - Locked
> Stability: 3 - Locked

The `assert` module provides a simple set of assertion tests that can be used to
test invariants. The module is intended for internal use by Node.js, but can be
Expand Down
24 changes: 12 additions & 12 deletions doc/api/buffer.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Buffer

Stability: 2 - Stable
> Stability: 2 - Stable

Prior to the introduction of [`TypedArray`] in ECMAScript 2015 (ES6), the
JavaScript language had no mechanism for reading or manipulating streams
Expand Down Expand Up @@ -300,7 +300,7 @@ It can be constructed in a variety of ways.
deprecated: v6.0.0
-->

Stability: 0 - Deprecated: Use [`Buffer.from(array)`] instead.
> Stability: 0 - Deprecated: Use [`Buffer.from(array)`] instead.

* `array` {Array} An array of bytes to copy from

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

Stability: 0 - Deprecated: Use [`Buffer.from(buffer)`] instead.
> Stability: 0 - Deprecated: Use [`Buffer.from(buffer)`] instead.

* `buffer` {Buffer} An existing `Buffer` to copy data from

Expand All @@ -344,9 +344,9 @@ console.log(buf2.toString());
deprecated: v6.0.0
-->

Stability: 0 - Deprecated: Use
[`Buffer.from(arrayBuffer[, byteOffset [, length]])`][`Buffer.from(arrayBuffer)`]
instead.
> Stability: 0 - Deprecated: Use
> [`Buffer.from(arrayBuffer[, byteOffset [, length]])`][`Buffer.from(arrayBuffer)`]
> instead.

* `arrayBuffer` {ArrayBuffer} The `.buffer` property of a [`TypedArray`] or
[`ArrayBuffer`]
Expand Down Expand Up @@ -387,8 +387,8 @@ console.log(buf);
deprecated: v6.0.0
-->

Stability: 0 - Deprecated: Use [`Buffer.alloc()`] instead (also see
[`Buffer.allocUnsafe()`]).
> Stability: 0 - Deprecated: Use [`Buffer.alloc()`] instead (also see
> [`Buffer.allocUnsafe()`]).

* `size` {Integer} The desired length of the new `Buffer`

Expand Down Expand Up @@ -420,8 +420,8 @@ console.log(buf);
deprecated: v6.0.0
-->

Stability: 0 - Deprecated:
Use [`Buffer.from(string[, encoding])`][`Buffer.from(string)`] instead.
> Stability: 0 - Deprecated:
> Use [`Buffer.from(string[, encoding])`][`Buffer.from(string)`] instead.

* `string` {String} String to encode
* `encoding` {String} The encoding of `string`. **Default:** `'utf8'`
Expand Down Expand Up @@ -2309,7 +2309,7 @@ On 64-bit architectures, this value is `(2^31)-1` (~2GB).
deprecated: v6.0.0
-->

Stability: 0 - Deprecated: Use [`Buffer.allocUnsafeSlow()`] instead.
> Stability: 0 - Deprecated: Use [`Buffer.allocUnsafeSlow()`] instead.

Returns an un-pooled `Buffer`.

Expand Down Expand Up @@ -2349,7 +2349,7 @@ has observed undue memory retention in their applications.
deprecated: v6.0.0
-->

Stability: 0 - Deprecated: Use [`Buffer.allocUnsafeSlow()`] instead.
> Stability: 0 - Deprecated: Use [`Buffer.allocUnsafeSlow()`] instead.

* `size` {Integer} The desired length of the new `SlowBuffer`

Expand Down
2 changes: 1 addition & 1 deletion doc/api/child_process.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Child Process

Stability: 2 - Stable
> Stability: 2 - Stable

The `child_process` module provides the ability to spawn child processes in
a manner that is similar, but not identical, to popen(3). This capability
Expand Down
4 changes: 2 additions & 2 deletions doc/api/cluster.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Cluster

Stability: 2 - Stable
> Stability: 2 - Stable

A single instance of Node.js runs in a single thread. To take advantage of
multi-core systems the user will sometimes want to launch a cluster of Node.js
Expand Down Expand Up @@ -395,7 +395,7 @@ if (cluster.isMaster) {

### worker.suicide

Stability: 0 - Deprecated: Use [`worker.exitedAfterDisconnect`][] instead.
> Stability: 0 - Deprecated: Use [`worker.exitedAfterDisconnect`][] instead.

An alias to [`worker.exitedAfterDisconnect`][].

Expand Down
2 changes: 1 addition & 1 deletion doc/api/console.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Console

Stability: 2 - Stable
> Stability: 2 - Stable

The `console` module provides a simple debugging console that is similar to the
JavaScript console mechanism provided by web browsers.
Expand Down
6 changes: 3 additions & 3 deletions doc/api/crypto.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Crypto

Stability: 2 - Stable
> Stability: 2 - Stable

The `crypto` module provides cryptographic functionality that includes a set of
wrappers for OpenSSL's hash, HMAC, cipher, decipher, sign and verify functions.
Expand Down Expand Up @@ -510,7 +510,7 @@ public point (key) is also generated and set in the ECDH object.

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

Stability: 0 - Deprecated
> Stability: 0 - Deprecated

Sets the EC Diffie-Hellman public key. Key encoding can be `'latin1'`,
`'hex'` or `'base64'`. If `encoding` is provided `public_key` is expected to
Expand Down Expand Up @@ -918,7 +918,7 @@ The `key` is the raw key used by the `algorithm` and `iv` is an

### crypto.createCredentials(details)

Stability: 0 - Deprecated: Use [`tls.createSecureContext()`][] instead.
> Stability: 0 - Deprecated: Use [`tls.createSecureContext()`][] instead.

The `crypto.createCredentials()` method is a deprecated alias for creating
and returning a `tls.SecureContext` object. The `crypto.createCredentials()`
Expand Down
2 changes: 1 addition & 1 deletion doc/api/debugger.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Debugger

Stability: 2 - Stable
> Stability: 2 - Stable

<!-- type=misc -->

Expand Down
2 changes: 1 addition & 1 deletion doc/api/dgram.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# UDP / Datagram Sockets

Stability: 2 - Stable
> Stability: 2 - Stable

<!-- name=dgram -->

Expand Down
2 changes: 1 addition & 1 deletion doc/api/dns.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# DNS

Stability: 2 - Stable
> Stability: 2 - Stable

The `dns` module contains functions belonging to two different categories:

Expand Down
2 changes: 1 addition & 1 deletion doc/api/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ Please do not suggest API changes in this area; they will be refused.

## JSON Output

Stability: 1 - Experimental
> Stability: 1 - Experimental

Every HTML file in the markdown has a corresponding JSON file with the
same data.
Expand Down
6 changes: 3 additions & 3 deletions doc/api/domain.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Domain

Stability: 0 - Deprecated
> Stability: 0 - Deprecated

**This module is pending deprecation**. Once a replacement API has been
finalized, this module will be fully deprecated. Most end users should
Expand Down Expand Up @@ -436,8 +436,8 @@ without exiting the domain.

### domain.dispose()

Stability: 0 - Deprecated. Please recover from failed IO actions
explicitly via error event handlers set on the domain.
> Stability: 0 - Deprecated. Please recover from failed IO actions
> explicitly via error event handlers set on the domain.

Once `dispose` has been called, the domain will no longer be used by callbacks
bound into the domain via `run`, `bind`, or `intercept`, and a `'dispose'` event
Expand Down
4 changes: 2 additions & 2 deletions doc/api/events.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Events

Stability: 2 - Stable
> Stability: 2 - Stable

<!--type=module-->

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

### EventEmitter.listenerCount(emitter, eventName)

Stability: 0 - Deprecated: Use [`emitter.listenerCount()`][] instead.
> 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`.
Expand Down
8 changes: 4 additions & 4 deletions doc/api/fs.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# File System

Stability: 2 - Stable
> Stability: 2 - Stable

<!--name=fs-->

Expand Down Expand Up @@ -584,7 +584,7 @@ added: v0.0.2
deprecated: v1.0.0
-->

Stability: 0 - Deprecated: Use [`fs.stat()`][] or [`fs.access()`][] instead.
> Stability: 0 - Deprecated: Use [`fs.stat()`][] or [`fs.access()`][] instead.

* `path` {String | Buffer}
* `callback` {Function}
Expand All @@ -610,8 +610,8 @@ added: v0.1.21
deprecated: v1.0.0
-->

Stability: 0 - Deprecated: Use [`fs.statSync()`][] or [`fs.accessSync()`][]
instead.
> Stability: 0 - Deprecated: Use [`fs.statSync()`][] or [`fs.accessSync()`][]
> instead.

* `path` {String | Buffer}

Expand Down
2 changes: 1 addition & 1 deletion doc/api/globals.md
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ Error.

### require.extensions

Stability: 0 - Deprecated
> Stability: 0 - Deprecated

* {Object}

Expand Down
4 changes: 2 additions & 2 deletions doc/api/http.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# HTTP

Stability: 2 - Stable
> Stability: 2 - Stable

To use the HTTP server and client one must `require('http')`.

Expand Down Expand Up @@ -1331,7 +1331,7 @@ added: v0.1.13
deprecated: v0.3.6
-->

Stability: 0 - Deprecated: Use [`http.request()`][] instead.
> Stability: 0 - Deprecated: Use [`http.request()`][] instead.

Constructs a new HTTP client. `port` and `host` refer to the server to be
connected to.
Expand Down
2 changes: 1 addition & 1 deletion doc/api/https.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# HTTPS

Stability: 2 - Stable
> Stability: 2 - Stable

HTTPS is the HTTP protocol over TLS/SSL. In Node.js this is implemented as a
separate module.
Expand Down
2 changes: 1 addition & 1 deletion doc/api/modules.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Modules

Stability: 3 - Locked
> Stability: 3 - Locked

<!--name=module-->

Expand Down
4 changes: 2 additions & 2 deletions doc/api/net.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# net

Stability: 2 - Stable
> Stability: 2 - Stable

The `net` module provides you with an asynchronous network wrapper. It contains
functions for creating both servers and clients (called streams). You can include
Expand Down Expand Up @@ -98,7 +98,7 @@ added: v0.2.0
deprecated: v0.9.7
-->

Stability: 0 - Deprecated: Use [`server.getConnections()`][] instead.
> Stability: 0 - Deprecated: Use [`server.getConnections()`][] instead.

The number of concurrent connections on the server.

Expand Down
2 changes: 1 addition & 1 deletion doc/api/os.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# OS

Stability: 2 - Stable
> Stability: 2 - Stable

The `os` module provides a number of operating system-related utility methods.
It can be accessed using:
Expand Down
2 changes: 1 addition & 1 deletion doc/api/path.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Path

Stability: 2 - Stable
> Stability: 2 - Stable

The `path` module provides utilities for working with file and directory paths.
It can be accessed using:
Expand Down
2 changes: 1 addition & 1 deletion doc/api/punycode.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# punycode

Stability: 0 - Deprecated
> Stability: 0 - Deprecated

**The version of the punycode module bundled in Node.js is being deprecated**.
In a future major version of Node.js this module will be removed. Users
Expand Down
2 changes: 1 addition & 1 deletion doc/api/querystring.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Query String

Stability: 2 - Stable
> Stability: 2 - Stable

<!--name=querystring-->

Expand Down
2 changes: 1 addition & 1 deletion doc/api/readline.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Readline

Stability: 2 - Stable
> Stability: 2 - Stable

The `readline` module provides an interface for reading data from a [Readable][]
stream (such as [`process.stdin`]) one line at a time. It can be accessed using:
Expand Down
4 changes: 2 additions & 2 deletions doc/api/repl.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# REPL

Stability: 2 - Stable
> Stability: 2 - Stable

The `repl` module provides a Read-Eval-Print-Loop (REPL) implementation that
is available both as a standalone program or includable in other applications.
Expand Down Expand Up @@ -444,7 +444,7 @@ added: v2.0.0
deprecated: v3.0.0
-->

Stability: 0 - Deprecated: Use `NODE_REPL_HISTORY` instead.
> Stability: 0 - Deprecated: Use `NODE_REPL_HISTORY` instead.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Niiice. This fixed an actual error: https://nodejs.org/api/repl.html#repl_node_repl_history_file — that line had three spaces instead of four =).


Previously in Node.js/io.js v2.x, REPL history was controlled by using a
`NODE_REPL_HISTORY_FILE` environment variable, and the history was saved in JSON
Expand Down
2 changes: 1 addition & 1 deletion doc/api/stream.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Stream

Stability: 2 - Stable
> Stability: 2 - Stable

A stream is an abstract interface for working with streaming data in Node.js.
The `stream` module provides a base API that makes it easy to build objects
Expand Down
2 changes: 1 addition & 1 deletion doc/api/string_decoder.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# StringDecoder

Stability: 2 - Stable
> Stability: 2 - Stable

The `string_decoder` module provides an API for decoding `Buffer` objects into
strings in a manner that preserves encoded multi-byte UTF-8 and UTF-16
Expand Down
2 changes: 1 addition & 1 deletion doc/api/timers.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Timers

Stability: 3 - Locked
> Stability: 3 - Locked

The `timer` module exposes a global API for scheduling functions to
be called at some future period of time. Because the timer functions are
Expand Down
Loading