Skip to content

doc: clarify stdout/stderr arguments to callback - #6015

Closed
jasnell wants to merge 2 commits into
nodejs:masterfrom
jasnell:doc-clarify-fs-doc
Closed

doc: clarify stdout/stderr arguments to callback#6015
jasnell wants to merge 2 commits into
nodejs:masterfrom
jasnell:doc-clarify-fs-doc

Conversation

@jasnell

@jasnelljasnell commented Apr 2, 2016

Copy link
Copy Markdown
Member

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

@jasnelljasnell 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

jasnell commented Apr 2, 2016

Copy link
Copy Markdown
MemberAuthor

@nodejs/documentation

@thefourtheye

thefourtheye commented Apr 2, 2016

Copy link
Copy Markdown
Contributor

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

@jasnell

jasnell commented Apr 2, 2016

Copy link
Copy Markdown
MemberAuthor

heh, sigh... it's late

@jasnell
jasnellforce-pushed the doc-clarify-fs-doc branch from a0e0a88 to 746a543CompareApril 2, 2016 06:25
@jasnell

jasnell commented Apr 2, 2016

Copy link
Copy Markdown
MemberAuthor

Fixed

@thefourtheye

thefourtheye commented Apr 2, 2016

Copy link
Copy Markdown
Contributor

LGTM

cjihrig
cjihrig reviewed Apr 2, 2016
View reviewed changes
Comment threaddoc/api/child_process.markdown Outdated

@cjihrigcjihrigApr 2, 2016

Copy link
Copy Markdown
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
jasnellforce-pushed the doc-clarify-fs-doc branch from 746a543 to 8c8910eCompareApril 3, 2016 00:16
@jasnell

jasnell commented Apr 3, 2016

Copy link
Copy Markdown
MemberAuthor

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

@cjihrig

cjihrig commented Apr 3, 2016

Copy link
Copy Markdown
Contributor

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

jasnell commented Apr 3, 2016

Copy link
Copy Markdown
MemberAuthor

Landed in 6fd26dc

@jasnelljasnell closed this Apr 3, 2016
MylesBorins pushed a commit that referenced this pull request Apr 5, 2016
@jasnellMyles Borins
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
@jasnellMyles Borins
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>
@MylesBorinsMylesBorins mentioned this pull request Apr 11, 2016
Merged
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

docIssues and PRs related to the documentations.fsIssues 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