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

http2: graduate from experimental #22466

Closed
wants to merge 3 commits into from
Closed

http2: graduate from experimental #22466

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3fd91dc
http2: graduate from experimental
jasnell Aug 23, 2018
374531b
squash! update wording
Trott Aug 24, 2018
496a0d1
squash! updating stability index
Trott Aug 24, 2018
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
10 changes: 7 additions & 3 deletions doc/api/http2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
# HTTP/2

<!-- YAML
added: v8.4.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/22466
description: HTTP/2 has graduated from experimental status.
Copy link
Member

Choose a reason for hiding this comment

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

Nit: Instead of "graduated from experimental status", it might be clearer to say "graduated to stable status" or even "graduated from experimental status to stable status".

Copy link
Member

Choose a reason for hiding this comment

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

Going even further with the nit: Leave "status" out and either say nothing or "stability index". And leave out "graduated".

HTTP/2 is now Stability Index 2 (Stable).

Or:

HTTP/2 is now Stability Index 2 (Stable). Previously, it had been Stability Index 1 (Experimental).

And if you really are feeling motivated, find some way to link to https://nodejs.org/api/documentation.html#documentation_stability_index.

Copy link
Member Author

Choose a reason for hiding this comment

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

Feel free to make those edits yourself if you'd like.

Copy link
Member

Choose a reason for hiding this comment

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

Will do!

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

@ChALkeR ChALkeR Aug 24, 2018 •
edited
Loading

Choose a reason for hiding this comment

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

The docs state when a module was introduced, but do not state when it was introduced out of experimental.
Any ideas how to improve this? /cc @nodejs/documentation
This is not blocking this PR from landing and it shouldn't depend on it, that is more like a related issue.

Copy link
Member Author

Choose a reason for hiding this comment

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

Should likely include it in the per-section changelog. I can update this to do so


> Stability: 1 - Experimental
Copy link
Member

Choose a reason for hiding this comment

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

Shouldn't this be changed to Stability: 2 - Stable rather than removed?


The `http2` module provides an implementation of the [HTTP/2][] protocol. It
can be accessed using:

Expand Down
6 changes: 0 additions & 6 deletions lib/http2.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,5 @@
'use strict';

process.emitWarning(
'The http2 module is an experimental API.',
'ExperimentalWarning', undefined,
'See https://github.com/nodejs/http2'
);

const {
constants,
getDefaultSettings,
Expand Down