From 463484b330d689252a4af0291dcbf403338a9823 Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Sun, 1 Oct 2017 19:41:59 -0700 Subject: [PATCH] doc: explain common.restore* functions MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Explain that `common.restoreStderr()` and `common.restoreStdout()` are for use with `common.hijackStderr()` and `common.hijackStdout()` respectively. PR-URL: https://github.com/nodejs/node/pull/15720 Reviewed-By: Ruben Bridgewater Reviewed-By: Vse Mozhet Byt Reviewed-By: Luigi Pinca Reviewed-By: Gibson Fahnestock Reviewed-By: Colin Ihrig Reviewed-By: Tobias Nießen Reviewed-By: James M Snell Reviewed-By: Jeremiah Senkpiel --- test/common/README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/test/common/README.md b/test/common/README.md index 2d30629e1edef3..8e837b2609f63a 100644 --- a/test/common/README.md +++ b/test/common/README.md @@ -323,11 +323,13 @@ Deletes the 'tmp' dir and recreates it ### restoreStderr() -Restore the original `process.stderr.write`. +Restore the original `process.stderr.write`. Used to restore `stderr` to its +original state after calling [`common.hijackStdErr()`][]. ### restoreStdout() -Restore the original `process.stdout.write`. +Restore the original `process.stdout.write`. Used to restore `stdout` to its +original state after calling [`common.hijackStdOut()`][]. ### rootDir * return [<String>] @@ -456,4 +458,6 @@ implementation with tests from [<Object>]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object [<RegExp>]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp [<String>]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type +[`common.hijackStdErr()`]: #hijackstderrlistener +[`common.hijackStdOut()`]: #hijackstdoutlistener [internationalization]: https://github.com/nodejs/node/wiki/Intl