diff options
author | Сковорода Никита Андреевич <chalkerx@gmail.com> | 2016-09-20 07:44:22 +0300 |
---|---|---|
committer | Сковорода Никита Андреевич <chalkerx@gmail.com> | 2016-09-25 13:02:45 +0300 |
commit | 50be885285c602c2aa1eb9c6010cb26fe7d186ff (patch) | |
tree | 61e6dab2850eb13f14552fbcb7bfc07d25267794 /doc/api | |
parent | d196c5d2af6b5727289bf2da68514517bd1c257f (diff) | |
download | android-node-v8-50be885285c602c2aa1eb9c6010cb26fe7d186ff.tar.gz android-node-v8-50be885285c602c2aa1eb9c6010cb26fe7d186ff.tar.bz2 android-node-v8-50be885285c602c2aa1eb9c6010cb26fe7d186ff.zip |
tools: enable more remark-lint rules
New rules:
1. rule-style
2. strong-marker
3. no-shell-dollars
4. no-inline-padding
5. code-block-style
6. no-multiple-toplevel-headings
Fixes to the existing files applied.
PR-URL: https://github.com/nodejs/node/pull/8708
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Ilkka Myller <ilkka.myller@nodefield.com>
Reviewed-By: Johan Bergström <bugs@bergstroem.nu>
Reviewed-By: James M Snell <jasnell@gmail.com>
Diffstat (limited to 'doc/api')
-rw-r--r-- | doc/api/addons.md | 2 | ||||
-rw-r--r-- | doc/api/debugger.md | 2 | ||||
-rw-r--r-- | doc/api/dns.md | 4 | ||||
-rw-r--r-- | doc/api/net.md | 8 | ||||
-rw-r--r-- | doc/api/process.md | 14 | ||||
-rw-r--r-- | doc/api/util.md | 2 |
6 files changed, 17 insertions, 15 deletions
diff --git a/doc/api/addons.md b/doc/api/addons.md index a239e15de6..1dfdf8e3bb 100644 --- a/doc/api/addons.md +++ b/doc/api/addons.md @@ -243,7 +243,7 @@ filename to the `sources` array. For example: Once the `binding.gyp` file is ready, the example Addons can be configured and built using `node-gyp`: -```sh +```console $ node-gyp configure build ``` diff --git a/doc/api/debugger.md b/doc/api/debugger.md index acffe65cba..dfe2f90973 100644 --- a/doc/api/debugger.md +++ b/doc/api/debugger.md @@ -181,7 +181,7 @@ localhost:5858 ## V8 Inspector Integration for Node.js -__NOTE: This is an experimental feature.__ +**NOTE: This is an experimental feature.** V8 Inspector integration allows attaching Chrome DevTools to Node.js instances for debugging and profiling. diff --git a/doc/api/dns.md b/doc/api/dns.md index 5d5354c3ef..95592f9cc3 100644 --- a/doc/api/dns.md +++ b/doc/api/dns.md @@ -6,9 +6,9 @@ The `dns` module contains functions belonging to two different categories: 1) Functions that use the underlying operating system facilities to perform name resolution, and that do not necessarily perform any network communication. -This category contains only one function: [`dns.lookup()`][]. __Developers +This category contains only one function: [`dns.lookup()`][]. **Developers looking to perform name resolution in the same way that other applications on -the same operating system behave should use [`dns.lookup()`][].__ +the same operating system behave should use [`dns.lookup()`][].** For example, looking up `nodejs.org`. diff --git a/doc/api/net.md b/doc/api/net.md index 491e74fc61..f1b206308c 100644 --- a/doc/api/net.md +++ b/doc/api/net.md @@ -207,8 +207,10 @@ persist*, they are removed when the last reference to them is closed. Do not forget JavaScript string escaping requires paths to be specified with double-backslashes, such as: - net.createServer().listen( - path.join('\\\\?\\pipe', process.cwd(), 'myctl')) +```js +net.createServer().listen( + path.join('\\\\?\\pipe', process.cwd(), 'myctl')) +``` The parameter `backlog` behaves the same as in [`server.listen([port][, hostname][, backlog][, callback])`][`server.listen(port, host, backlog, callback)`]. @@ -363,7 +365,7 @@ Emitted when data is received. The argument `data` will be a `Buffer` or `String`. Encoding of data is set by `socket.setEncoding()`. (See the [Readable Stream][] section for more information.) -Note that the __data will be lost__ if there is no listener when a `Socket` +Note that the **data will be lost** if there is no listener when a `Socket` emits a `'data'` event. ### Event: 'drain' diff --git a/doc/api/process.md b/doc/api/process.md index 94c5f2dc91..dc311872fa 100644 --- a/doc/api/process.md +++ b/doc/api/process.md @@ -478,7 +478,7 @@ process.argv.forEach((val, index) => { Launching the Node.js process as: -```sh +```console $ node process-2.js one two=three four ``` @@ -500,7 +500,7 @@ added: 6.4.0 The `process.argv0` property stores a read-only copy of the original value of `argv[0]` passed when Node.js starts. -```js +```console $ bash -c 'exec -a customArgv0 ./node' > process.argv[0] '/Volumes/code/external/node/out/Release/node' @@ -672,7 +672,7 @@ It is possible to modify this object, but such modifications will not be reflected outside the Node.js process. In other words, the following example would not work: -```sh +```console $ node -e 'process.env.foo = "bar"' && echo $foo ``` @@ -811,7 +811,7 @@ the same execution environment as the parent. For example: -```sh +```console $ node --harmony script.js --version ``` @@ -1461,7 +1461,7 @@ in several ways: 3. Writes _can_ block when output is redirected to a file. - Note that disks are fast and operating systems normally employ write-back caching so this is very uncommon. -4. Writes on UNIX __will__ block by default if output is going to a TTY +4. Writes on UNIX **will** block by default if output is going to a TTY (a terminal). 5. Windows functionality differs. Writes block except when output is going to a TTY. @@ -1519,7 +1519,7 @@ in several ways: 3. Writes _can_ block when output is redirected to a file. - Note that disks are fast and operating systems normally employ write-back caching so this is very uncommon. -4. Writes on UNIX __will__ block by default if output is going to a TTY +4. Writes on UNIX **will** block by default if output is going to a TTY (a terminal). 5. Windows functionality differs. Writes block except when output is going to a TTY. @@ -1537,7 +1537,7 @@ To check if Node.js is being run in a [TTY][] context, check the `isTTY` property on `process.stderr`, `process.stdout`, or `process.stdin`. For instance: -```sh +```console $ node -p "Boolean(process.stdin.isTTY)" true $ echo "foo" | node -p "Boolean(process.stdin.isTTY)" diff --git a/doc/api/util.md b/doc/api/util.md index 3cd80cb5dc..3ffefa3f87 100644 --- a/doc/api/util.md +++ b/doc/api/util.md @@ -626,7 +626,7 @@ deprecated: v4.0.0 * `object` {any} -Returns `true` if the given `object` is strictly an `Object` __and__ not a +Returns `true` if the given `object` is strictly an `Object` **and** not a `Function`. Otherwise, returns `false`. ```js |