summaryrefslogtreecommitdiff
path: root/doc/api/process.md
diff options
context:
space:
mode:
authorVse Mozhet Byt <vsemozhetbyt@gmail.com>2018-04-29 20:46:41 +0300
committerVse Mozhet Byt <vsemozhetbyt@gmail.com>2018-05-03 02:12:07 +0300
commit7588ceaf353af0f257d4d832bace4600edac704e (patch)
treecd01b69085d5c1134c43e61d8acc84586d1a188d /doc/api/process.md
parentbdf5be98dd901f6c312938198439dbda0b20d517 (diff)
downloadandroid-node-v8-7588ceaf353af0f257d4d832bace4600edac704e.tar.gz
android-node-v8-7588ceaf353af0f257d4d832bace4600edac704e.tar.bz2
android-node-v8-7588ceaf353af0f257d4d832bace4600edac704e.zip
doc: add more missing backticks
Also, fix some other nits in passing (formatting, punctuation, typos, redundancy, obsoleteness). PR-URL: https://github.com/nodejs/node/pull/20438 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Diffstat (limited to 'doc/api/process.md')
-rw-r--r--doc/api/process.md30
1 files changed, 15 insertions, 15 deletions
diff --git a/doc/api/process.md b/doc/api/process.md
index 9c0c26162e..8205efbd78 100644
--- a/doc/api/process.md
+++ b/doc/api/process.md
@@ -205,10 +205,10 @@ added: v1.4.1
changes:
- version: v7.0.0
pr-url: https://github.com/nodejs/node/pull/8217
- description: Not handling Promise rejections has been deprecated.
+ description: Not handling `Promise` rejections has been deprecated.
- version: v6.6.0
pr-url: https://github.com/nodejs/node/pull/8223
- description: Unhandled Promise rejections will now emit
+ description: Unhandled `Promise` rejections will now emit
a process warning.
-->
@@ -234,7 +234,7 @@ process.on('unhandledRejection', (reason, p) => {
somePromise.then((res) => {
return reportToUser(JSON.pasre(res)); // note the typo (`pasre`)
-}); // no `.catch` or `.then`
+}); // no `.catch()` or `.then()`
```
The following will also trigger the `'unhandledRejection'` event to be
@@ -524,7 +524,7 @@ added: v0.7.7
* {Object}
-The `process.config` property returns an Object containing the JavaScript
+The `process.config` property returns an `Object` containing the JavaScript
representation of the configure options used to compile the current Node.js
executable. This is the same as the `config.gypi` file that was produced when
running the `./configure` script.
@@ -699,10 +699,10 @@ added: v8.0.0
* `warning` {string|Error} The warning to emit.
* `options` {Object}
- * `type` {string} When `warning` is a String, `type` is the name to use
+ * `type` {string} When `warning` is a `String`, `type` is the name to use
for the *type* of warning being emitted. **Default:** `'Warning'`.
* `code` {string} A unique identifier for the warning instance being emitted.
- * `ctor` {Function} When `warning` is a String, `ctor` is an optional
+ * `ctor` {Function} When `warning` is a `String`, `ctor` is an optional
function used to limit the generated stack trace. **Default:**
`process.emitWarning`.
* `detail` {string} Additional text to include with the error.
@@ -744,10 +744,10 @@ added: v6.0.0
-->
* `warning` {string|Error} The warning to emit.
-* `type` {string} When `warning` is a String, `type` is the name to use
+* `type` {string} When `warning` is a `String`, `type` is the name to use
for the *type* of warning being emitted. **Default:** `'Warning'`.
* `code` {string} A unique identifier for the warning instance being emitted.
-* `ctor` {Function} When `warning` is a String, `ctor` is an optional
+* `ctor` {Function} When `warning` is a `String`, `ctor` is an optional
function used to limit the generated stack trace. **Default:**
`process.emitWarning`.
@@ -1151,12 +1151,12 @@ added: v0.7.6
* Returns: {integer[]}
The `process.hrtime()` method returns the current high-resolution real time
-in a `[seconds, nanoseconds]` tuple Array, where `nanoseconds` is the
+in a `[seconds, nanoseconds]` tuple `Array`, where `nanoseconds` is the
remaining part of the real time that can't be represented in second precision.
`time` is an optional parameter that must be the result of a previous
`process.hrtime()` call to diff with the current time. If the parameter
-passed in is not a tuple Array, a `TypeError` will be thrown. Passing in a
+passed in is not a tuple `Array`, a `TypeError` will be thrown. Passing in a
user-defined array instead of the result of a previous call to
`process.hrtime()` will lead to undefined behavior.
@@ -1401,7 +1401,7 @@ function definitelyAsync(arg, cb) {
The next tick queue is completely drained on each pass of the event loop
**before** additional I/O is processed. As a result, recursively setting
-nextTick callbacks will block any I/O from happening, just like a
+`nextTick()` callbacks will block any I/O from happening, just like a
`while(true);` loop.
## process.noDeprecation
@@ -1482,8 +1482,8 @@ changes:
* {Object}
-The `process.release` property returns an Object containing metadata related to
-the current release, including URLs for the source tarball and headers-only
+The `process.release` property returns an `Object` containing metadata related
+to the current release, including URLs for the source tarball and headers-only
tarball.
`process.release` contains the following properties:
@@ -1741,7 +1741,7 @@ The `process.stdout` property returns a stream connected to
stream) unless fd `1` refers to a file, in which case it is
a [Writable][] stream.
-For example, to copy process.stdin to process.stdout:
+For example, to copy `process.stdin` to `process.stdout`:
```js
process.stdin.pipe(process.stdout);
@@ -1961,7 +1961,7 @@ cases:
* `7` **Internal Exception Handler Run-Time Failure** - There was an
uncaught exception, and the internal fatal exception handler
function itself threw an error while attempting to handle it. This
- can happen, for example, if a [`'uncaughtException'`][] or
+ can happen, for example, if an [`'uncaughtException'`][] or
`domain.on('error')` handler throws an error.
* `8` - Unused. In previous versions of Node.js, exit code 8 sometimes
indicated an uncaught exception.