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: add missing introduced_in comments #16741

Closed
wants to merge 1 commit into from
Closed

doc: add missing introduced_in comments #16741

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
2 changes: 2 additions & 0 deletions doc/api/async_hooks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Async Hooks

<!--introduced_in=v8.1.0-->

> Stability: 1 - Experimental

The `async_hooks` module provides an API to register callbacks tracking the
Expand Down
2 changes: 2 additions & 0 deletions doc/api/deprecations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Deprecated APIs

<!--introduced_in=v7.7.0-->

Node.js may deprecate APIs when either: (a) use of the API is considered to be
unsafe, (b) an improved alternative API has been made available, or (c)
breaking changes to the API are expected in a future major release.
Expand Down
2 changes: 1 addition & 1 deletion doc/api/esm.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# ECMAScript Modules

<!--introduced_in=v9.x.x-->
<!--introduced_in=v8.5.0-->
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Non-blocking nit/question: Is the helpful/interesting information to include when the feature was introduced as Experimental or is it when it is introduced as Stable? I would argue Stable is what I'd expect to see and what would be useful when looking in docs. In which case, this probably should stay as is?

Copy link
Member Author

@lpinca lpinca Nov 5, 2017 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this should use the first version in which the feature was documented regardless of the stability. Aren't docs for an experimental feature useful? If so why adding them in the first place?

That said, I'm fine with changing/removing the comment in all experimental modules/features.


> Stability: 1 - Experimental

Expand Down
2 changes: 2 additions & 0 deletions doc/api/http2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# HTTP2

<!--introduced_in=v8.4.0-->
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same "Stable or Experimental?" questions as above.


> Stability: 1 - Experimental

The `http2` module provides an implementation of the [HTTP/2][] protocol. It
Expand Down
2 changes: 2 additions & 0 deletions doc/api/inspector.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Inspector

<!--introduced_in=v8.0.0-->

> Stability: 1 - Experimental

The `inspector` module provides an API for interacting with the V8 inspector.
Expand Down
2 changes: 2 additions & 0 deletions doc/api/intl.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Internationalization Support

<!--introduced_in=v8.2.0-->

Node.js has many features that make it easier to write internationalized
programs. Some of them are:

Expand Down
2 changes: 2 additions & 0 deletions doc/api/n-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# N-API

<!--introduced_in=v7.10.0-->

> Stability: 1 - Experimental

N-API (pronounced N as in the letter, followed by API)
Expand Down
5 changes: 2 additions & 3 deletions doc/api/perf_hooks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
# Performance Timing API
<!-- YAML
added: v8.5.0
-->

<!--introduced_in=v8.5.0-->

> Stability: 1 - Experimental

Expand Down
2 changes: 2 additions & 0 deletions doc/api/tracing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Tracing

<!--introduced_in=v7.7.0-->

Trace Event provides a mechanism to centralize tracing information generated by
V8, Node core, and userspace code.

Expand Down