From 5d2ba44fcac6ae2cc525503fcbb531f1e9de1299 Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Tue, 7 Feb 2017 13:08:52 -0800 Subject: [PATCH] doc: edit maxBuffer/Unicode paragraph for clarity Remove unneeded words from child_process doc. PR-URL: https://github.com/nodejs/node/pull/11228 Reviewed-By: James M Snell Reviewed-By: Colin Ihrig --- doc/api/child_process.md | 15 +++++---------- 1 file changed, 5 insertions(+), 10 deletions(-) diff --git a/doc/api/child_process.md b/doc/api/child_process.md index c541837b91e302..938c3d513b5874 100644 --- a/doc/api/child_process.md +++ b/doc/api/child_process.md @@ -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