diff options
| author | Vse Mozhet Byt <vsemozhetbyt@gmail.com> | 2018-04-02 08:38:48 +0300 |
|---|---|---|
| committer | Vse Mozhet Byt <vsemozhetbyt@gmail.com> | 2018-04-04 13:45:39 +0300 |
| commit | de0053cc3280bdf72c9010f383290f79120a1e98 (patch) | |
| tree | 493fc9bd84c3d8e97342202d0a840b4fe29bdd6e /doc/api/util.md | |
| parent | 237cbe10fb82ba6ec69b14193a4a970e184306e7 (diff) | |
| download | android-node-v8-de0053cc3280bdf72c9010f383290f79120a1e98.tar.gz android-node-v8-de0053cc3280bdf72c9010f383290f79120a1e98.tar.bz2 android-node-v8-de0053cc3280bdf72c9010f383290f79120a1e98.zip | |
doc: fix various nits
* Replace 2 hyphens (--) by spaced m-dashes (—) as per STYLE_GUIDE.md.
* Space infix operators.
* Unify quotes in inline code spans (use only single quotes).
* Unify `* Returns:` (eliminate deviations).
* Dedupe spaces.
PR-URL: https://github.com/nodejs/node/pull/19743
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Diffstat (limited to 'doc/api/util.md')
| -rw-r--r-- | doc/api/util.md | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/doc/api/util.md b/doc/api/util.md index caee5990fb..e5d57759e5 100644 --- a/doc/api/util.md +++ b/doc/api/util.md @@ -78,9 +78,9 @@ added: v0.11.3 The `util.debuglog()` method is used to create a function that conditionally writes debug messages to `stderr` based on the existence of the `NODE_DEBUG` -environment variable. If the `section` name appears within the value of that +environment variable. If the `section` name appears within the value of that environment variable, then the returned function operates similar to -[`console.error()`][]. If not, then the returned function is a no-op. +[`console.error()`][]. If not, then the returned function is a no-op. ```js const util = require('util'); @@ -96,7 +96,7 @@ it will output something like: FOO 3245: hello from foo [123] ``` -where `3245` is the process id. If it is not run with that +where `3245` is the process id. If it is not run with that environment variable set, then it will not print anything. The `section` supports wildcard also: @@ -203,7 +203,7 @@ corresponding argument. Supported placeholders are: * `%d` - Number (integer or floating point value). * `%i` - Integer. * `%f` - Floating point value. -* `%j` - JSON. Replaced with the string `'[Circular]'` if the argument +* `%j` - JSON. Replaced with the string `'[Circular]'` if the argument contains circular references. * `%o` - Object. A string representation of an object with generic JavaScript object formatting. @@ -289,7 +289,7 @@ that the two styles are [semantically incompatible][]. * `constructor` {Function} * `superConstructor` {Function} -Inherit the prototype methods from one [constructor][] into another. The +Inherit the prototype methods from one [constructor][] into another. The prototype of `constructor` will be set to a new object created from `superConstructor`. |