Skip to content

Commit

Permalink
doc: use blockquotes for Stability: markers
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
addaleax authored and MylesBorins committed Oct 26, 2016
1 parent cadb261 commit 2a2971b
Show file tree
Hide file tree
Showing 37 changed files with 107 additions and 76 deletions.
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
2 changes: 1 addition & 1 deletion 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
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
2 changes: 1 addition & 1 deletion 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
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 @@ -495,7 +495,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 `'binary'`,
`'hex'` or `'base64'`. If `encoding` is provided `public_key` is expected to
Expand Down Expand Up @@ -892,7 +892,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 @@ -244,7 +244,7 @@ The `'removeListener'` event is emitted *after* a 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
7 changes: 4 additions & 3 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 @@ -476,7 +476,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.
Test whether or not the given path exists by checking with the file system.
Then call the `callback` argument with either true or false. Example:
Expand All @@ -499,7 +499,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.
Synchronous version of [`fs.exists()`][].
Returns `true` if the file exists, `false` otherwise.
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 @@ -1274,7 +1274,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 @@ -97,7 +97,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
Provides a few basic operating-system related utility functions.

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
This module contains utilities for handling and transforming file
paths. Almost all these methods perform only string transformations.
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: 2 - Stable
> Stability: 2 - Stable
[Punycode.js][] is bundled with Node.js v0.5.1+. Use `require('punycode')` to
access it. (To use it with other Node.js versions, use npm to install the
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
To use this module, do `require('readline')`. Readline allows reading of a
stream (such as [`process.stdin`][]) on a line-by-line basis.
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
A Read-Eval-Print-Loop (REPL) is available both as a standalone program and
easily includable in other programs. The REPL provides a way to interactively
Expand Down Expand Up @@ -56,7 +56,7 @@ disabled by setting the environment variable `NODE_REPL_HISTORY=""`.

### NODE_REPL_HISTORY_FILE

Stability: 0 - Deprecated: Use `NODE_REPL_HISTORY` instead.
> Stability: 0 - Deprecated: Use `NODE_REPL_HISTORY` instead.
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 implemented by various objects in
Node.js. For example a [request to an HTTP server][http-incoming-message] is a
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
To use this module, do `require('string_decoder')`. StringDecoder decodes a
buffer to a string. It is a simple interface to `buffer.toString()` but provides
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
All of the timer functions are globals. You do not need to `require()`
this module in order to use them.
Expand Down
4 changes: 2 additions & 2 deletions doc/api/tls.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# TLS (SSL)

Stability: 2 - Stable
> Stability: 2 - Stable
Use `require('tls')` to access this module.

Expand Down Expand Up @@ -159,7 +159,7 @@ is expensive.

## Class: CryptoStream

Stability: 0 - Deprecated: Use [`tls.TLSSocket`][] instead.
> Stability: 0 - Deprecated: Use [`tls.TLSSocket`][] instead.
This is an encrypted stream.

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

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

## tty.setRawMode(mode)

Stability: 0 - Deprecated: Use [tty.ReadStream#setRawMode][] (i.e. process.stdin.setRawMode) instead.
> Stability: 0 - Deprecated: Use [tty.ReadStream#setRawMode][] (i.e. process.stdin.setRawMode) instead.
[tty.ReadStream#setRawMode]: #tty_rs_setrawmode_mode
2 changes: 1 addition & 1 deletion doc/api/url.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# URL

Stability: 2 - Stable
> Stability: 2 - Stable
This module has utilities for URL resolution and parsing.
Call `require('url')` to use it.
Expand Down
Loading

0 comments on commit 2a2971b

Please sign in to comment.