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

consider printing Experimental warnings for all Experimental APIs #9036

Closed
Fishrock123 opened this issue Oct 11, 2016 · 5 comments
Closed

consider printing Experimental warnings for all Experimental APIs #9036

Fishrock123 opened this issue Oct 11, 2016 · 5 comments
Labels
help wanted Issues that need assistance from volunteers or PRs that need help to proceed. meta Issues and PRs related to the general management of the project. stalled Issues and PRs that are stalled.

Comments

@Fishrock123
Copy link
Contributor

Thought of this in #7448 (comment)

Maybe we should codify to always print warnings on access/use of Experimental features? Imo makes it more clear to anyone running the code that it may change / be removed / etc etc.

cc @jasnell
@Fishrock123 Fishrock123 added the meta Issues and PRs related to the general management of the project. label Oct 11, 2016
@jasnell
Copy link
Member

jasnell commented Oct 11, 2016

Definitely worth considering. Can be done in a reasonably painless and consistent way via a new internal/util method like emitExperimentalWarning('feature-name').

@evanlucas evanlucas mentioned this issue Oct 11, 2016
Closed
4 tasks
evanlucas added a commit to evanlucas/node that referenced this issue Oct 17, 2016
@evanlucas
process: add emitExperimentalWarning()
bb243f0 
This adds process.emitExperimentalWarning() which can used to
communicate to our users that a feature they are using is experimental
and can be changed/removed at any time.

Ref: nodejs#9036
evanlucas added a commit to evanlucas/node that referenced this issue Oct 31, 2016
@evanlucas
internal: emit experimental warning when using --inspect
0322d54 
This is currently an experimental feature, so we should make sure users
are aware that it can be changed at any time.

Ref: nodejs#9036
@sam-github sam-github mentioned this issue May 11, 2017
Closed
2 tasks
@Trott
Copy link
Member

Trott commented Jul 15, 2017

Anyone want to pick this up? If not, anyone willing to mentor someone willing to do it? If so, let's add the mentor available label.

@Trott Trott added the help wanted Issues that need assistance from volunteers or PRs that need help to proceed. label Jul 15, 2017
@ssbrewster
Copy link
Contributor

ssbrewster commented Sep 12, 2017 •
edited
Loading

@Trott @Fishrock123 I would like to pick this one up. But where is it at? Shall I just pick up from where #9042 left off and fix the outstanding issues on that PR (which may lead to more refactoring once I get an understanding of how it should work)?

@codeman869 codeman869 mentioned this issue Oct 25, 2017
Closed
4 tasks
codeman869 added a commit to codeman869/node that referenced this issue Nov 16, 2017
@codeman869
internal: add emitExperimentalWarning function
81dc7ff 
Adds a new emitExperimentalWarning function to internal/util to warn
users that they are using an experimental feature and that feature can
change at any time.

Refs: nodejs#9036
targos pushed a commit that referenced this issue Nov 23, 2017
@codeman869 @targos
internal: add emitExperimentalWarning function
b08c732 
Adds a new emitExperimentalWarning function to internal/util to warn
users that they are using an experimental feature and that feature can
change at any time.

PR-URL: #16497
Refs: #9036
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
MylesBorins pushed a commit that referenced this issue Dec 12, 2017
@codeman869 @MylesBorins
internal: add emitExperimentalWarning function
6cd7c79 
Adds a new emitExperimentalWarning function to internal/util to warn
users that they are using an experimental feature and that feature can
change at any time.

PR-URL: #16497
Refs: #9036
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
MylesBorins pushed a commit that referenced this issue Dec 12, 2017
@codeman869 @MylesBorins
internal: add emitExperimentalWarning function
8fd316f 
Adds a new emitExperimentalWarning function to internal/util to warn
users that they are using an experimental feature and that feature can
change at any time.

PR-URL: #16497
Refs: #9036
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
gibfahn pushed a commit that referenced this issue Dec 19, 2017
@codeman869 @gibfahn
internal: add emitExperimentalWarning function
b1bfced 
Adds a new emitExperimentalWarning function to internal/util to warn
users that they are using an experimental feature and that feature can
change at any time.

PR-URL: #16497
Refs: #9036
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
gibfahn pushed a commit that referenced this issue Dec 20, 2017
@codeman869 @gibfahn
internal: add emitExperimentalWarning function
e6a568b 
Adds a new emitExperimentalWarning function to internal/util to warn
users that they are using an experimental feature and that feature can
change at any time.

PR-URL: #16497
Refs: #9036
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
@apapirovski
Copy link
Member

We do have a function now which was added in #16497 but it's currently not being used in lib (but at least it has tests). Perhaps a good follow-up would be to figure out how to make the rest of the code use it and extend it as necessary to make that happen?

@richardlau richardlau mentioned this issue Nov 5, 2018
Merged
4 tasks
@Trott
Copy link
Member

Trott commented Nov 6, 2018

It seems like perhaps this should be closed. Feel free to re-open (or leave a comment requesting that it be re-opened) if you disagree. (Or, perhaps better, open a PR.) I'm just tidying up and not acting on a super-strong opinion or anything like that.

@Trott Trott closed this as completed Nov 6, 2018
@Trott Trott added the stalled Issues and PRs that are stalled. label Nov 6, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
help wanted Issues that need assistance from volunteers or PRs that need help to proceed. meta Issues and PRs related to the general management of the project. stalled Issues and PRs that are stalled.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
5 participants
@apapirovski @jasnell @Trott @Fishrock123 @ssbrewster