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.

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

doc: the «Deprecated» stability index description is inaccurate #12829

Closed
ChALkeR opened this issue May 4, 2017 · 2 comments
Closed

doc: the «Deprecated» stability index description is inaccurate #12829

ChALkeR opened this issue May 4, 2017 · 2 comments
Labels
doc Issues and PRs related to the documentations.

Comments

@ChALkeR
Copy link
Member

ChALkeR commented May 4, 2017

Previous discussion at #12723 (comment).

The description of the Deprecated stability index in fact contradicts with the recent decision about the old Buffer API. It is currently deprecated in a sense that a complete drop-in replacement exists and that the old API usage is highly discouraged, but we recently decided on a CTC vote that we do not plan any changes there at this point. The description in the documentation directly contradicts that.

Current description:

Deprecated: This feature is known to be problematic, and changes are planned. Do not rely on it. Use of the feature may cause warnings. Backwards compatibility should not be expected.

The same question affects domain — it's labelled as Deprecated, but can we say now that we have plans actually removing/changing that? Related: #10843.

/cc @jasnell @addaleax @Trott @MylesBorins

@ChALkeR ChALkeR changed the title doc: the «Deprecated» stability index is inaccurate doc: the «Deprecated» stability index description is inaccurate May 4, 2017
@mscdex mscdex added the doc Issues and PRs related to the documentations. label May 4, 2017
@refack
Copy link
Contributor

refack commented May 4, 2017

IMHO simplest solution is to explicitly state the status of these two modules in a note at the end of the definition...
meta-deprecation of the deprecation definition... 😲

@Trott
Copy link
Member

Trott commented Aug 6, 2017

As of 5c2d1af3103, it says "changes may be planned" rather than "changes are planned" so I think this can be closed. As always, re-open if I'm wrong…

@Trott Trott closed this as completed Aug 6, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Issues and PRs related to the documentations.
Projects
None yet
Development

No branches or pull requests

4 participants