Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc, tools: unify stability signatures #20552

Closed
wants to merge 1 commit into from
Closed

doc, tools: unify stability signatures #20552

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 18 additions & 18 deletions doc/api/documentation.md
View file
Open in desktop
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
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -252,8 +252,7 @@ function parseLists(input) {
state = savedState.pop();
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