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.

Sign up for GitHub

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

Jump to bottom

doc: add history of options param being added to fs.readdir() #12312

Closed
wants to merge 2 commits into from
Closed

doc: add history of options param being added to fs.readdir() #12312

wants to merge 2 commits into from

Conversation

shubheksha
Copy link
Contributor

@shubheksha shubheksha commented Apr 10, 2017 •
edited
Loading

Checklist
Affected core subsystem(s)

doc

Fixes #12299

@nodejs-github-bot nodejs-github-bot added doc Issues and PRs related to the documentations. fs Issues and PRs related to the fs subsystem / file system. labels Apr 10, 2017
Trott
Trott reviewed Apr 10, 2017
View reviewed changes
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
Copy link
Member

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.

@shubheksha shubheksha changed the title add history of options param being added to fs readdir doc: add history of options param being added to fs.readdir() Apr 10, 2017
aqrln
aqrln approved these changes Apr 10, 2017
View reviewed changes
Copy link
Contributor

@aqrln aqrln left a 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

@shubheksha
doc: add missing changelog entry for fs.readdir()
2b28f79 
Document that the `options` parameter of `fs.readdir()` was added
in Node.js 6.0.0.

Fixes: #12299
@shubheksha
Copy link
Contributor Author

@aqrln, done!

@aqrln
Copy link
Contributor

aqrln commented Apr 12, 2017

Landed in 4ac3ef5. Thanks!

@aqrln aqrln closed this Apr 12, 2017
aqrln pushed a commit that referenced this pull request Apr 12, 2017
@shubheksha @aqrln
doc: add missing changelog entry for fs.readdir()
4ac3ef5 
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>
evanlucas pushed a commit that referenced this pull request Apr 25, 2017
@shubheksha @evanlucas
doc: add missing changelog entry for fs.readdir()
1078b82 
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>
@evanlucas evanlucas mentioned this pull request May 1, 2017
Merged
evanlucas pushed a commit that referenced this pull request May 1, 2017
@shubheksha @evanlucas
doc: add missing changelog entry for fs.readdir()
614577f 
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>
evanlucas pushed a commit that referenced this pull request May 2, 2017
@shubheksha @evanlucas
doc: add missing changelog entry for fs.readdir()
aa51105 
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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Trott Trott Trott left review comments

@vsemozhetbyt vsemozhetbyt vsemozhetbyt approved these changes

@aqrln aqrln aqrln approved these changes

@cjihrig cjihrig cjihrig approved these changes

@addaleax addaleax addaleax approved these changes

@jasnell jasnell jasnell approved these changes

@sam-github sam-github sam-github approved these changes

Assignees
No one assigned
Labels
doc Issues and PRs related to the documentations. fs Issues and PRs related to the fs subsystem / file system.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

readdir docs don’t mention when options argument was added
9 participants
@shubheksha @aqrln @sam-github @jasnell @Trott @addaleax @cjihrig @vsemozhetbyt @nodejs-github-bot