Skip to content

Commit

Permalink
doc, tools: unify stability signatures
Browse files Browse the repository at this point in the history
PR-URL: #20552
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
  • Loading branch information
vsemozhetbyt authored and targos committed May 12, 2018
1 parent d327893 commit 4a7bb40
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 20 deletions.
36 changes: 18 additions & 18 deletions doc/api/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 1 addition & 2 deletions tools/doc/html.js
Original file line number Diff line number Diff line change
Expand Up @@ -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]);
Expand Down

0 comments on commit 4a7bb40

Please sign in to comment.