-
Notifications
You must be signed in to change notification settings - Fork 30.5k
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: clarify arguments on fs.create{Read|Write}Stream #2023
Conversation
I don't think that's the most important part of the doc, there is no reason for it to be bold. |
I agree with @ChALkeR. |
Exactly, so better just to accept functions everywhere. No one will likely ever do it or care, but if someone ever does find a use case for it, they won't be frustrated. There is likely no use case for passing an Array or a Buffer as the options object, and it looks just as confusing, yet it's allowed. |
I feel like there is a misunderstanding here. The original issue (#1981) has nothing to do with the use of functions as option objects. A function is being wrongly used as if |
@ChALkeR I removed the bold style.
Yes, I agree. So currently we don't need to put the label "(except function)" in all API docs.
-1, I have a same opinion with @targos . And we should discuss how document is improved in the docs repo. https://github.com/nodejs/docs |
The documentation wouldn't change in this case, so I don't see why the users would suddenly start trying to pass functions. |
I'm going to close this for now, as it seems like there is some pushback and it has sat here for a while. cc @nodejs/documentation if they want to do anything with it? |
Lots of discussions on this PR, #1998
But I would like to clarify the fs.create{Read|Write}Stream arguments to prevent misleading the issue #1981