-
Notifications
You must be signed in to change notification settings - Fork 29.8k
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
Comments
That's wrong and I believe I'm responsible for that in all three cases; mea culpa. They can be marked as '2 - Stable'. |
If I may, I think differently (for 2/3) - |
fs.watchFile() is not really unstable, it's that in most cases fs.watch() is a better, more scalable alternative. |
Okay - @Trott would you like to send in a PR? |
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. |
Fixes: #1754 PR-URL: #1775 Reviewed-By: Brendan Ashworth <[email protected]> Reviewed-By: Jeremiah Senkpiel <[email protected]>
Fixed by eb1856d |
Fixes: nodejs/node#1754 PR-URL: nodejs/node#1775 Reviewed-By: Brendan Ashworth <[email protected]> Reviewed-By: Jeremiah Senkpiel <[email protected]>
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 thefs
doc needs to update those indices to different values, or ... ?The text was updated successfully, but these errors were encountered: