From ae85228e54cad6f1ab002db51d50cc8d37f654c3 Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Fri, 11 Sep 2020 04:17:39 -0700 Subject: [PATCH] doc: perform minor cleanup on cli.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * sort references in ASCII order * merge logically-connected single-sentence paragraphs * remove _please_ from referrals to other docs * remove unnecessary italics * make some text more concise * change some instances of future tense to present tense PR-URL: https://github.com/nodejs/node/pull/35152 Reviewed-By: Michaël Zasso Reviewed-By: Anna Henningsen Reviewed-By: Daijiro Wachi --- doc/api/cli.md | 58 ++++++++++++++++++++++++-------------------------- 1 file changed, 28 insertions(+), 30 deletions(-) diff --git a/doc/api/cli.md b/doc/api/cli.md index a3125de072b604..9f9a07056f0600 100644 --- a/doc/api/cli.md +++ b/doc/api/cli.md @@ -18,7 +18,7 @@ To view this documentation as a manual page in a terminal, run `man node`. Execute without arguments to start the [REPL][]. -_For more info about `node inspect`, please see the [debugger][] documentation._ +For more info about `node inspect`, see the [debugger][] documentation. ## Options All options, including V8 options, allow words to be separated by both -dashes (`-`) or underscores (`_`). +dashes (`-`) or underscores (`_`). For example, `--pending-deprecation` is +equivalent to `--pending_deprecation`. -For example, `--pending-deprecation` is equivalent to `--pending_deprecation`. - -If an option that takes a single value, for example `--max-http-header-size`, -is passed more than once, then the last passed value will be used. Options -from the command line take precedence over options passed through the -[`NODE_OPTIONS`][] environment variable. +If an option that takes a single value (such as `--max-http-header-size`) is +passed more than once, then the last passed value is used. Options from the +command line take precedence over options passed through the [`NODE_OPTIONS`][] +environment variable. ### `-` Alias for stdin. Analogous to the use of `-` in other command line utilities, -meaning that the script will be read from stdin, and the rest of the options +meaning that the script is read from stdin, and the rest of the options are passed to that script. ### `--` @@ -55,7 +54,7 @@ added: v6.11.0 Indicate the end of node options. Pass the rest of the arguments to the script. If no script filename or eval/print script is supplied prior to this, then -the next argument will be used as a script filename. +the next argument is used as a script filename. ### `--abort-on-uncaught-exception` Disable the `Object.prototype.__proto__` property. If `mode` is `delete`, the -property will be removed entirely. If `mode` is `throw`, accesses to the -property will throw an exception with the code `ERR_PROTO_ACCESS`. +property is removed entirely. If `mode` is `throw`, accesses to the +property throw an exception with the code `ERR_PROTO_ACCESS`. ### `--disallow-code-generation-from-strings`