Skip to content

Commit 4a7bb40

Browse files
vsemozhetbyttargos
authored andcommitted
doc, tools: unify stability signatures
PR-URL: #20552 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
1 parent d327893 commit 4a7bb40

File tree

2 files changed

+19
-20
lines changed

2 files changed

+19
-20
lines changed

doc/api/documentation.md

+18-18
Original file line numberDiff line numberDiff line change
@@ -34,24 +34,24 @@ and in the process of being redesigned.
3434

3535
The stability indices are as follows:
3636

37-
```txt
38-
Stability: 0 - Deprecated. This feature is known to be problematic, and changes
39-
may be planned. Do not rely on it. Use of the feature may cause warnings to be
40-
emitted. Backwards compatibility across major versions should not be expected.
41-
```
42-
43-
```txt
44-
Stability: 1 - Experimental. This feature is still under active development and
45-
subject to non-backwards compatible changes, or even removal, in any future
46-
version. Use of the feature is not recommended in production environments.
47-
Experimental features are not subject to the Node.js Semantic Versioning model.
48-
```
49-
50-
```txt
51-
Stability: 2 - Stable. The API has proven satisfactory. Compatibility with the
52-
npm ecosystem is a high priority, and will not be broken unless absolutely
53-
necessary.
54-
```
37+
> Stability: 0 - Deprecated. This feature is known to be problematic, and
38+
> changes may be planned. Do not rely on it. Use of the feature may cause
39+
> warnings to be emitted. Backwards compatibility across major versions should
40+
> not be expected.
41+
42+
<!-- separator -->
43+
44+
> Stability: 1 - Experimental. This feature is still under active development
45+
> and subject to non-backwards compatible changes, or even removal, in any
46+
> future version. Use of the feature is not recommended in production
47+
> environments. Experimental features are not subject to the Node.js Semantic
48+
> Versioning model.
49+
50+
<!-- separator -->
51+
52+
> Stability: 2 - Stable. The API has proven satisfactory. Compatibility with the
53+
> npm ecosystem is a high priority, and will not be broken unless absolutely
54+
> necessary.
5555
5656
Caution must be used when making use of `Experimental` features, particularly
5757
within modules that may be used as dependencies (or dependencies of

tools/doc/html.js

+1-2
Original file line numberDiff line numberDiff line change
@@ -256,8 +256,7 @@ function preprocessElements(input) {
256256
state = null;
257257
return;
258258
}
259-
if ((tok.type === 'paragraph' && state === 'MAYBE_STABILITY_BQ') ||
260-
tok.type === 'code') {
259+
if (tok.type === 'paragraph' && state === 'MAYBE_STABILITY_BQ') {
261260
if (tok.text.match(/Stability:.*/g)) {
262261
const stabilityMatch = tok.text.match(STABILITY_TEXT_REG_EXP);
263262
const stability = Number(stabilityMatch[2]);

0 commit comments

Comments
 (0)