From 59aa4e9e2956b585c2a5aaaa578f9e2ed9808e64 Mon Sep 17 00:00:00 2001 From: Myles Borins Date: Wed, 21 Dec 2016 14:14:16 -0500 Subject: [PATCH] doc: consistent 'Returns:' part two Follow up from 8eb19c4. Lower case `return` was not updated PR-URL: https://github.com/nodejs/node/pull/10391 Ref: https://github.com/nodejs/node/pull/9554 Reviewed-By: Colin Ihrig Reviewed-By: Julian Duque Reviewed-By: Jeremiah Senkpiel Reviewed-By: Anna Henningsen Reviewed-By: Luigi Pinca Reviewed-By: Roman Reiss Reviewed-By: James M Snell --- doc/api/child_process.md | 8 ++++---- doc/api/domain.md | 6 +++--- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/doc/api/child_process.md b/doc/api/child_process.md index 02f6a057e72585..4433e14ddc00fa 100644 --- a/doc/api/child_process.md +++ b/doc/api/child_process.md @@ -318,7 +318,7 @@ added: v0.1.90 `'/bin/sh'` on UNIX, and `'cmd.exe'` on Windows. A different shell can be specified as a string. The shell should understand the `-c` switch on UNIX, or `/s /c` on Windows. Defaults to `false` (no shell). -* return: {ChildProcess} +* Returns: {ChildProcess} The `child_process.spawn()` method spawns a new process using the given `command`, with command line arguments in `args`. If omitted, `args` defaults @@ -588,7 +588,7 @@ added: v0.11.12 * [`maxBuffer`][] {Number} largest amount of data (in bytes) allowed on stdout or stderr - if exceeded child process is killed * `encoding` {String} The encoding used for all stdio inputs and outputs. (Default: `'buffer'`) -* return: {Buffer|String} The stdout from the command +* Returns: {Buffer|String} The stdout from the command The `child_process.execFileSync()` method is generally identical to [`child_process.execFile()`][] with the exception that the method will not return @@ -631,7 +631,7 @@ added: v0.11.12 stdout or stderr - if exceeded child process is killed * `encoding` {String} The encoding used for all stdio inputs and outputs. (Default: `'buffer'`) -* return: {Buffer|String} The stdout from the command +* Returns: {Buffer|String} The stdout from the command The `child_process.execSync()` method is generally identical to [`child_process.exec()`][] with the exception that the method will not return until @@ -673,7 +673,7 @@ added: v0.11.12 `'/bin/sh'` on UNIX, and `'cmd.exe'` on Windows. A different shell can be specified as a string. The shell should understand the `-c` switch on UNIX, or `/s /c` on Windows. Defaults to `false` (no shell). -* return: {Object} +* Returns: {Object} * `pid` {Number} Pid of the child process * `output` {Array} Array of results from stdio output * `stdout` {Buffer|String} The contents of `output[1]` diff --git a/doc/api/domain.md b/doc/api/domain.md index e1dd65e05c45d3..86f5226d69e370 100644 --- a/doc/api/domain.md +++ b/doc/api/domain.md @@ -257,7 +257,7 @@ serverDomain.run(() => { ## domain.create() -* return: {Domain} +* Returns: {Domain} Returns a new Domain object. @@ -338,7 +338,7 @@ specified emitter. ### domain.bind(callback) * `callback` {Function} The callback function -* return: {Function} The bound function +* Returns: {Function} The bound function The returned function will be a wrapper around the supplied callback function. When the returned function is called, any errors that are @@ -366,7 +366,7 @@ d.on('error', (er) => { ### domain.intercept(callback) * `callback` {Function} The callback function -* return: {Function} The intercepted function +* Returns: {Function} The intercepted function This method is almost identical to [`domain.bind(callback)`][]. However, in addition to catching thrown errors, it will also intercept [`Error`][]