From 5f2b67dbcd13d5f1112ec9f6eaed1828c0d71e72 Mon Sep 17 00:00:00 2001 From: Vse Mozhet Byt Date: Sun, 6 May 2018 03:59:23 +0300 Subject: doc, tools: unify stability signatures PR-URL: https://github.com/nodejs/node/pull/20552 Reviewed-By: James M Snell Reviewed-By: Trivikram Kamat Reviewed-By: Luigi Pinca --- doc/api/documentation.md | 36 ++++++++++++++++++------------------ tools/doc/html.js | 3 +-- 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. + + + +> 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. + + + +> 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]); -- cgit v1.2.3