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: clarify stdout/stderr arguments to callback #6015

Closed
wants to merge 2 commits into from
Closed

doc: clarify stdout/stderr arguments to callback #6015

wants to merge 2 commits into from

Conversation

jasnell
Copy link
Member

@jasnell jasnell commented Apr 2, 2016

Pull Request check-list

  • Is the commit message formatted according to [CONTRIBUTING.md][0]?
  • Is a documentation update included (if this change modifies
    existing APIs, or introduces new ones)?

Affected core subsystem(s)

doc

Description of change

Clarify that the arguments to fs.execFile and fs.exec callback can be Buffer or strings.

Fixes: #3389

@jasnell jasnell added doc Issues and PRs related to the documentations. fs Issues and PRs related to the fs subsystem / file system. labels Apr 2, 2016
@jasnell
Copy link
Member Author

jasnell commented Apr 2, 2016

@nodejs/documentation

@thefourtheye
Copy link
Contributor

LGTM, but the commit log says fs.exec and fs.execFile, they are actually child_process.exec and child_process.execFile.

@jasnell
Copy link
Member Author

jasnell commented Apr 2, 2016

heh, sigh... it's late

@jasnell
Copy link
Member Author

jasnell commented Apr 2, 2016

Fixed

@thefourtheye
Copy link
Contributor

LGTM

cjihrig
cjihrig reviewed Apr 2, 2016
View reviewed changes
doc/api/child_process.markdown
The `stdout` and `stderr` arguments passed to the callback will contain the
stdout and stderr output of the child process. By default, Node.js will decode
the output as UTF-8 and pass strings to the callback. The `encoding` option
(see below) can be used to specify the character encoding used to decode the
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would either link to encoding or just leave off the (see below). These things tend to become wrong when things get moved around.

@jasnell
doc: clarify stdout/stderr arguments to callback
2997155 
Clarify that the arguments to child_process.execFile
and child_process.exec callback can be Buffer or strings.

Fixes: nodejs#3389
@jasnell
Address nit
8c8910e
@jasnell
Copy link
Member Author

jasnell commented Apr 3, 2016

@cjihrig ... pulled out the (see below). PTAL

@cjihrig
Copy link
Contributor

cjihrig commented Apr 3, 2016

LGTM

jasnell added a commit that referenced this pull request Apr 3, 2016
@jasnell
doc: clarify stdout/stderr arguments to callback
6fd26dc 
Clarify that the arguments to child_process.execFile
and child_process.exec callback can be Buffer or strings.

Fixes: #3389
PR-URL: #6015
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
@jasnell
Copy link
Member Author

jasnell commented Apr 3, 2016

Landed in 6fd26dc

@jasnell jasnell closed this Apr 3, 2016
MylesBorins pushed a commit that referenced this pull request Apr 5, 2016
@jasnell
doc: clarify stdout/stderr arguments to callback
f12c386 
Clarify that the arguments to child_process.execFile
and child_process.exec callback can be Buffer or strings.

Fixes: #3389
PR-URL: #6015
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
This was referenced Apr 5, 2016
Closed
Merged
MylesBorins pushed a commit that referenced this pull request Apr 11, 2016
@jasnell
doc: clarify stdout/stderr arguments to callback
56755de 
Clarify that the arguments to child_process.execFile
and child_process.exec callback can be Buffer or strings.

Fixes: #3389
PR-URL: #6015
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
@MylesBorins MylesBorins mentioned this pull request Apr 11, 2016
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
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.
4 participants
@jasnell @thefourtheye @cjihrig @MylesBorins