Permalink
Browse files

doc: edit maxBuffer/Unicode paragraph for clarity

Remove unneeded words from child_process doc.

PR-URL: #11228
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
  • Loading branch information...
Trott authored and italoacasas committed Feb 7, 2017
1 parent 9339891 commit 5d2ba44fcac6ae2cc525503fcbb531f1e9de1299
Showing with 5 additions and 10 deletions.
  1. +5 −10 doc/api/child_process.md
View
@@ -1157,16 +1157,11 @@ to the same value.
## `maxBuffer` and Unicode
-It is important to keep in mind that the `maxBuffer` option specifies the
-largest number of *octets* allowed on `stdout` or `stderr`. If this value is
-exceeded, then the child process is terminated. This particularly impacts
-output that includes multibyte character encodings such as UTF-8 or UTF-16.
-For instance, the following will output 13 UTF-8 encoded octets to `stdout`
-although there are only 4 characters:
-
-```js
-console.log('中文测试');
-```
+The `maxBuffer` option specifies the largest number of bytes allowed on `stdout`
+or `stderr`. If this value is exceeded, then the child process is terminated.
+This impacts output that includes multibyte character encodings such as UTF-8 or
+UTF-16. For instance, `console.log('中文测试')` will send 13 UTF-8 encoded bytes
+to `stdout` although there are only 4 characters.
[`'error'`]: #child_process_event_error
[`'exit'`]: #child_process_event_exit

0 comments on commit 5d2ba44

Please sign in to comment.