lukechilds
/
node
mirror of https://github.com/lukechilds/node.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

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 <cjihrig@gmail.com>
Reviewed-By: Julian Duque <julianduquej@gmail.com>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Roman Reiss <me@silverwind.io>
Reviewed-By: James M Snell <jasnell@gmail.com>
v4.x
Myles Borins 8 years ago
committed by Myles Borins
parent
3b252a69a0
commit
dda777bf9e
No known key found for this signature in database GPG Key ID: 933B01F40B5CA946
2 changed files with 7 additions and 7 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 8
      doc/api/child_process.md
  2. 6
      doc/api/domain.md

8
doc/api/child_process.md
View File

@ -308,7 +308,7 @@ added: v0.1.90
'/bin/sh' on UNIX, and 'cmd.exe' on Windows. A different shell can be '/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, specified as a string. The shell should understand the `-c` switch on UNIX,
or `/s /c` on Windows. Defaults to `false` (no shell). 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 The `child_process.spawn()` method spawns a new process using the given
`command`, with command line arguments in `args`. If omitted, `args` defaults `command`, with command line arguments in `args`. If omitted, `args` defaults
@ -567,7 +567,7 @@ added: v0.11.12
* `maxBuffer` {Number} largest amount of data (in bytes) allowed on stdout or * `maxBuffer` {Number} largest amount of data (in bytes) allowed on stdout or
stderr - if exceeded child process is killed stderr - if exceeded child process is killed
* `encoding` {String} The encoding used for all stdio inputs and outputs. (Default: 'buffer') * `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 The `child_process.execFileSync()` method is generally identical to
`child_process.execFile()` with the exception that the method will not return `child_process.execFile()` with the exception that the method will not return
@ -606,7 +606,7 @@ added: v0.11.12
* `maxBuffer` {Number} largest amount of data (in bytes) allowed on stdout or * `maxBuffer` {Number} largest amount of data (in bytes) allowed on stdout or
stderr - if exceeded child process is killed stderr - if exceeded child process is killed
* `encoding` {String} The encoding used for all stdio inputs and outputs. (Default: 'buffer') * `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 The `child_process.execSync()` method is generally identical to
`child_process.exec()` with the exception that the method will not return until `child_process.exec()` with the exception that the method will not return until
@ -644,7 +644,7 @@ added: v0.11.12
'/bin/sh' on UNIX, and 'cmd.exe' on Windows. A different shell can be '/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, specified as a string. The shell should understand the `-c` switch on UNIX,
or `/s /c` on Windows. Defaults to `false` (no shell). or `/s /c` on Windows. Defaults to `false` (no shell).
* return: {Object} * Returns: {Object}
* `pid` {Number} Pid of the child process * `pid` {Number} Pid of the child process
* `output` {Array} Array of results from stdio output * `output` {Array} Array of results from stdio output
* `stdout` {Buffer|String} The contents of `output[1]` * `stdout` {Buffer|String} The contents of `output[1]`

6
doc/api/domain.md
View File

@ -257,7 +257,7 @@ serverDomain.run(() => {
## domain.create() ## domain.create()
* return: {Domain} * Returns: {Domain}
Returns a new Domain object. Returns a new Domain object.
@ -337,7 +337,7 @@ specified emitter.
### domain.bind(callback) ### domain.bind(callback)
* `callback` {Function} The callback function * `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 The returned function will be a wrapper around the supplied callback
function. When the returned function is called, any errors that are function. When the returned function is called, any errors that are
@ -365,7 +365,7 @@ d.on('error', (er) => {
### domain.intercept(callback) ### domain.intercept(callback)
* `callback` {Function} The callback function * `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 This method is almost identical to [`domain.bind(callback)`][]. However, in
addition to catching thrown errors, it will also intercept [`Error`][] addition to catching thrown errors, it will also intercept [`Error`][]

Write Preview
Loading…
Cancel
Save