summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorVse Mozhet Byt <vsemozhetbyt@gmail.com>2018-05-06 03:59:23 +0300
committerVse Mozhet Byt <vsemozhetbyt@gmail.com>2018-05-09 00:52:13 +0300
commit5f2b67dbcd13d5f1112ec9f6eaed1828c0d71e72 (patch)
treefdc371570ac277c29b0907dfeeb174877c6bb84f
parenta76dfd24ec5c76d268ab2c6b6bd6a9cf36f602c6 (diff)
downloadandroid-node-v8-5f2b67dbcd13d5f1112ec9f6eaed1828c0d71e72.tar.gz
android-node-v8-5f2b67dbcd13d5f1112ec9f6eaed1828c0d71e72.tar.bz2
android-node-v8-5f2b67dbcd13d5f1112ec9f6eaed1828c0d71e72.zip
doc, tools: unify stability signatures
PR-URL: https://github.com/nodejs/node/pull/20552 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
-rw-r--r--doc/api/documentation.md36
-rw-r--r--tools/doc/html.js3
2 files changed, 19 insertions, 20 deletions
diff --git a/doc/api/documentation.md b/doc/api/documentation.md
index cbc7a34be8..a5909e3268 100644
--- a/doc/api/documentation.md
+++ b/doc/api/documentation.md
@@ -34,24 +34,24 @@ and in the process of being redesigned.
The stability indices are as follows:
-```txt
-Stability: 0 - Deprecated. This feature is known to be problematic, and changes
-may be planned. Do not rely on it. Use of the feature may cause warnings to be
-emitted. Backwards compatibility across major versions should not be expected.
-```
-
-```txt
-Stability: 1 - Experimental. This feature is still under active development and
-subject to non-backwards compatible changes, or even removal, in any future
-version. Use of the feature is not recommended in production environments.
-Experimental features are not subject to the Node.js Semantic Versioning model.
-```
-
-```txt
-Stability: 2 - Stable. The API has proven satisfactory. Compatibility with the
-npm ecosystem is a high priority, and will not be broken unless absolutely
-necessary.
-```
+> Stability: 0 - Deprecated. This feature is known to be problematic, and
+> changes may be planned. Do not rely on it. Use of the feature may cause
+> warnings to be emitted. Backwards compatibility across major versions should
+> not be expected.
+
+<!-- separator -->
+
+> Stability: 1 - Experimental. This feature is still under active development
+> and subject to non-backwards compatible changes, or even removal, in any
+> future version. Use of the feature is not recommended in production
+> environments. Experimental features are not subject to the Node.js Semantic
+> Versioning model.
+
+<!-- separator -->
+
+> Stability: 2 - Stable. The API has proven satisfactory. Compatibility with the
+> npm ecosystem is a high priority, and will not be broken unless absolutely
+> necessary.
Caution must be used when making use of `Experimental` features, particularly
within modules that may be used as dependencies (or dependencies of
diff --git a/tools/doc/html.js b/tools/doc/html.js
index 7712290b4c..00fd48d8e6 100644
--- a/tools/doc/html.js
+++ b/tools/doc/html.js
@@ -256,8 +256,7 @@ function preprocessElements(input) {
state = null;
return;
}
- if ((tok.type === 'paragraph' && state === 'MAYBE_STABILITY_BQ') ||
- tok.type === 'code') {
+ if (tok.type === 'paragraph' && state === 'MAYBE_STABILITY_BQ') {
if (tok.text.match(/Stability:.*/g)) {
const stabilityMatch = tok.text.match(STABILITY_TEXT_REG_EXP);
const stability = Number(stabilityMatch[2]);