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: Stability 2 (stable) listed as "unstable" in fs docs #1754

Closed
Trott opened this issue May 21, 2015 · 6 comments
Closed

doc: Stability 2 (stable) listed as "unstable" in fs docs #1754

Trott opened this issue May 21, 2015 · 6 comments
Labels
doc Issues and PRs related to the documentations.

Comments

@Trott
Copy link
Member

Trott commented May 21, 2015

https://github.com/nodejs/io.js/blob/master/doc/api/documentation.markdown#stability-index indicates that Stability 2 = Stable but there are three places in the doc/fs.md where Stability 2 is marked Unstable. Not sure if the doc about stability index needs clarification, or if the fs doc needs to update those indices to different values, or ... ?

@mscdex mscdex added the doc Issues and PRs related to the documentations. label May 21, 2015
@bnoordhuis
Copy link
Member

That's wrong and I believe I'm responsible for that in all three cases; mea culpa. They can be marked as '2 - Stable'.

@brendanashworth
Copy link
Contributor

If I may, I think differently (for 2/3) - fs.watchFile seems to be unstable by the description suggesting an alternative. Perhaps this is related to #943?

@bnoordhuis
Copy link
Member

fs.watchFile() is not really unstable, it's that in most cases fs.watch() is a better, more scalable alternative.

@brendanashworth
Copy link
Contributor

Okay - @Trott would you like to send in a PR?

@Trott
Copy link
Member Author

Trott commented May 23, 2015

OK, done, PR submitted, #1775.

Not sure if it's less-than-ideal to have "Stable" right next to advice to use something else if possible. But that can be a subject of a different issue if necessary. The PR addresses the micro-issue of correctly labeling the stability index value.

Fishrock123 pushed a commit that referenced this issue May 26, 2015
Fixes: #1754
PR-URL: #1775
Reviewed-By: Brendan Ashworth <brendan.ashworth@me.com>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
@Fishrock123
Copy link
Contributor

Fixed by eb1856d

andrewdeandrade pushed a commit to andrewdeandrade/node that referenced this issue Jun 3, 2015
Fixes: nodejs/node#1754
PR-URL: nodejs/node#1775
Reviewed-By: Brendan Ashworth <brendan.ashworth@me.com>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
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

5 participants