doc: some fixes in child_process.md #10102

vsemozhetbyt · 2016-12-03T05:52:58Z

Checklist

documentation is changed or added
commit message follows commit guidelines

Affected core subsystem(s)

doc, child_process

Description of change

assert.equal => assert.strictEqual.
let => const for the variable that is not reassigned.
Fix indentation and internal spaces in code bits.
Stringify buffers in code examples to prevent erroneous raw buffer outputs.
Fix a typo.

thefourtheye · 2016-12-03T06:07:51Z

doc/api/child_process.md

@@ -91,11 +91,11 @@ const spawn = require('child_process').spawn;
 const bat = spawn('cmd.exe', ['/c', 'my.bat']);

 bat.stdout.on('data', (data) => {
-  console.log(data);
+  console.log(`${data}`);


I would say, calling toString explicitly would be clearer.

I was following this line. Should I change it as well?

console.log('%s', data)?

@thefourtheye, @sam-github So which of these two variants should I apply?

what two variants?

Oh, I see. I think console.log('%s', data) is more idiomatic. Code using console.log() should use its facilities. console.log(data.toString()) just seems a cumbersome version. @thefourtheye, what do you think?

Personally, I feel like data.toString() has clearer intent, but I'm good either way.

So we have 3:1 (considering emoji) for data.toString().

sam-github · 2016-12-03T06:27:32Z

doc/api/child_process.md

+  stdio: [
+    0, // Use parents stdin for child
+    'pipe', // Pipe child's stdout to parent
+    fs.openSync('err.out', 'w') // Direct child's stderr to a file


this is an fd leak, because the fd is never closed

@thefourtheye, @sam-github I'm not sure how to fix this. It requires rewriting the previous paragraph. Maybe it could be fixed in a separate PR?

+1 for another PR. The issue is already there, this is just altering indentation.

sam-github · 2016-12-07T18:41:02Z

LGTM, despite the unexplained aversion to format strings :-)

vsemozhetbyt · 2016-12-09T18:42:55Z

ping @nodejs/documentation

Qard · 2016-12-09T19:02:37Z

LGTM also.

sam-github

LGTM. Please squash into one commit with a bullet list of changes, I would describe this as "doc: modernize child_process example code".

vsemozhetbyt · 2016-12-09T22:05:50Z

@sam-github I hope I've done it right... I don't know why the bot has added this dont-land-on-v7.x label after squashing, though.

thefourtheye · 2016-12-10T18:10:16Z

doc/api/child_process.md

-      fs.openSync('err.out', 'w') // Direct child's stderr to a file
-    ]
+  stdio: [
+    0, // Use parents stdin for child


Nit: parent's

@thefourtheye Fixed

1. equal => strictEqual. 2. let => const for the variable that is not reassigned. 3. fix spaces. 4. stringify erroneous raw buffer outputs. 5. fix a typo.

1. equal => strictEqual. 2. let => const for the variable that is not reassigned. 3. fix spaces. 4. stringify erroneous raw buffer outputs. 5. fix a typo. PR-URL: nodejs#10102 Reviewed-By: Sam Roberts <vieuxtech@gmail.com> Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>

sam-github · 2016-12-12T15:57:26Z

Landed in f418a22

1. equal => strictEqual. 2. let => const for the variable that is not reassigned. 3. fix spaces. 4. stringify erroneous raw buffer outputs. 5. fix a typo. PR-URL: #10102 Reviewed-By: Sam Roberts <vieuxtech@gmail.com> Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>

1. equal => strictEqual. 2. let => const for the variable that is not reassigned. 3. fix spaces. 4. stringify erroneous raw buffer outputs. 5. fix a typo. PR-URL: nodejs#10102 Reviewed-By: Sam Roberts <vieuxtech@gmail.com> Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>

1. equal => strictEqual. 2. let => const for the variable that is not reassigned. 3. fix spaces. 4. stringify erroneous raw buffer outputs. 5. fix a typo. PR-URL: #10102 Reviewed-By: Sam Roberts <vieuxtech@gmail.com> Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>

1. equal => strictEqual. 2. let => const for the variable that is not reassigned. 3. fix spaces. 4. stringify erroneous raw buffer outputs. 5. fix a typo. PR-URL: nodejs#10102 Reviewed-By: Sam Roberts <vieuxtech@gmail.com> Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>

1. equal => strictEqual. 2. let => const for the variable that is not reassigned. 3. fix spaces. 4. stringify erroneous raw buffer outputs. 5. fix a typo. PR-URL: #10102 Reviewed-By: Sam Roberts <vieuxtech@gmail.com> Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>

nodejs-github-bot added child_process Issues and PRs related to the child_process subsystem. doc Issues and PRs related to the documentations. labels Dec 3, 2016

vsemozhetbyt changed the title ~~Child process.md~~ doc: some fixes in child_process.md Dec 3, 2016

thefourtheye reviewed Dec 3, 2016

View reviewed changes

sam-github reviewed Dec 3, 2016

View reviewed changes

sam-github suggested changes Dec 9, 2016

View reviewed changes

nodejs-github-bot added the dont-land-on-v7.x label Dec 9, 2016

thefourtheye approved these changes Dec 10, 2016

View reviewed changes

doc: modernize child_process example code

839ce2b

1. equal => strictEqual. 2. let => const for the variable that is not reassigned. 3. fix spaces. 4. stringify erroneous raw buffer outputs. 5. fix a typo.

nodejs-github-bot added the dont-land-on-v7.x label Dec 10, 2016

sam-github approved these changes Dec 12, 2016

View reviewed changes

sam-github closed this Dec 12, 2016

vsemozhetbyt deleted the child_process.md branch December 12, 2016 15:58

mscdex removed the dont-land-on-v7.x label Jan 13, 2017

MylesBorins added dont-land-on-v4.x labels Jan 16, 2017

MylesBorins mentioned this pull request Jan 24, 2017

v6.10.0 proposal #10974

Merged

italoacasas mentioned this pull request Jan 25, 2017

Proposal to update v7.x-staging #10989

Closed

italoacasas mentioned this pull request Jan 29, 2017

v7.5.0 proposal #11062

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

doc: some fixes in child_process.md #10102

doc: some fixes in child_process.md #10102

vsemozhetbyt commented Dec 3, 2016 •

edited

Loading

thefourtheye Dec 3, 2016

vsemozhetbyt Dec 3, 2016

sam-github Dec 3, 2016

sam-github Dec 3, 2016

vsemozhetbyt Dec 4, 2016

sam-github Dec 6, 2016

sam-github Dec 6, 2016

Qard Dec 7, 2016

vsemozhetbyt Dec 7, 2016

sam-github Dec 3, 2016

vsemozhetbyt Dec 4, 2016 •

edited

Loading

Qard Dec 7, 2016

sam-github Dec 9, 2016

sam-github commented Dec 7, 2016

vsemozhetbyt commented Dec 9, 2016

Qard commented Dec 9, 2016

sam-github left a comment

vsemozhetbyt commented Dec 9, 2016

thefourtheye Dec 10, 2016

vsemozhetbyt Dec 10, 2016

sam-github commented Dec 12, 2016

doc: some fixes in child_process.md #10102

doc: some fixes in child_process.md #10102

Conversation

vsemozhetbyt commented Dec 3, 2016 • edited Loading

Checklist

Affected core subsystem(s)

Description of change

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vsemozhetbyt Dec 4, 2016 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sam-github commented Dec 7, 2016

vsemozhetbyt commented Dec 9, 2016

Qard commented Dec 9, 2016

sam-github left a comment

Choose a reason for hiding this comment

vsemozhetbyt commented Dec 9, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sam-github commented Dec 12, 2016

vsemozhetbyt commented Dec 3, 2016 •

edited

Loading

vsemozhetbyt Dec 4, 2016 •

edited

Loading