-
Notifications
You must be signed in to change notification settings - Fork 28.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: add history of options
param being added to fs.readdir()
#12312
Conversation
doc/api/fs.md
Outdated
@@ -1442,6 +1442,9 @@ changes: | |||
pr-url: https://github.com/nodejs/node/pull/7897 | |||
description: The `callback` parameter is no longer optional. Not passing | |||
it will emit a deprecation warning. | |||
- version: v6.0.0 | |||
pr-url: https://github.com/nodejs/node/pull/5616 | |||
description: The `options` parameter was added |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nit: Add .
at the end.
options
param being added to fs.readdir()
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, but the first line of the commit message should not exceed 50 characters and the "Fixes: #12299" metadata field should be added to the commit message. How about something like this?
doc: add missing changelog entry for fs.readdir()
Document that the `options` parameter of `fs.readdir()` was added
in Node.js 6.0.0.
Fixes: https://github.com/nodejs/node/issues/12299
Document that the `options` parameter of `fs.readdir()` was added in Node.js 6.0.0. Fixes: #12299
@aqrln, done! |
Landed in 4ac3ef5. Thanks! |
Document that the `options` parameter of `fs.readdir()` was added in Node.js 6.0.0. PR-URL: #12312 Fixes: #12299 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Sam Roberts <vieuxtech@gmail.com> Reviewed-By: Alexey Orlenko <eaglexrlnk@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
Document that the `options` parameter of `fs.readdir()` was added in Node.js 6.0.0. PR-URL: #12312 Fixes: #12299 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Sam Roberts <vieuxtech@gmail.com> Reviewed-By: Alexey Orlenko <eaglexrlnk@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
Document that the `options` parameter of `fs.readdir()` was added in Node.js 6.0.0. PR-URL: #12312 Fixes: #12299 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Sam Roberts <vieuxtech@gmail.com> Reviewed-By: Alexey Orlenko <eaglexrlnk@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
Document that the `options` parameter of `fs.readdir()` was added in Node.js 6.0.0. PR-URL: #12312 Fixes: #12299 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Sam Roberts <vieuxtech@gmail.com> Reviewed-By: Alexey Orlenko <eaglexrlnk@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
Checklist
Affected core subsystem(s)
doc
Fixes #12299