diff options
author | Daijiro Wachi <daijiro.wachi@gmail.com> | 2017-06-28 21:55:48 +0300 |
---|---|---|
committer | Daijiro Wachi <daijiro.wachi@gmail.com> | 2017-07-03 12:06:36 +0300 |
commit | 8b2c61c1698bb01fd54e78d27b90356606864f84 (patch) | |
tree | 7a188a225684cdd006aae485b34a6b95d8fa9b79 /doc | |
parent | 9955c30df34e4fc17282e0cbed13fa9dc483b5b5 (diff) |
doc: fix api docs style
doc/api/cluster.md
L337: Use the definition link
doc/api/deprecations.md
L106: Fix the definition link name
doc/api/errors.md
L901: Remove unused definition
PR-URL: https://github.com/nodejs/node/pull/13970
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: David Cai <davidcai1993@yahoo.com>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/api/cluster.md | 2 | ||||
-rw-r--r-- | doc/api/deprecations.md | 2 | ||||
-rw-r--r-- | doc/api/errors.md | 1 |
3 files changed, 2 insertions, 3 deletions
diff --git a/doc/api/cluster.md b/doc/api/cluster.md index 721b33a7e18..e371583b3a7 100644 --- a/doc/api/cluster.md +++ b/doc/api/cluster.md @@ -334,7 +334,7 @@ added: v6.0.0 Set by calling `.kill()` or `.disconnect()`. Until then, it is `undefined`. -The boolean `worker.exitedAfterDisconnect` allows distinguishing between +The boolean [`worker.exitedAfterDisconnect`][] allows distinguishing between voluntary and accidental exit, the master may choose not to respawn a worker based on this value. diff --git a/doc/api/deprecations.md b/doc/api/deprecations.md index 5fb3974bb1a..6a2714befc1 100644 --- a/doc/api/deprecations.md +++ b/doc/api/deprecations.md @@ -103,7 +103,7 @@ In an earlier version of the Node.js `cluster`, a boolean property with the name `suicide` was added to the `Worker` object. The intent of this property was to provide an indication of how and why the `Worker` instance exited. In Node.js 6.0.0, the old property was deprecated and replaced with a new -[worker.exitedAfterDisconnect][] property. The old property name did not +[`worker.exitedAfterDisconnect`][] property. The old property name did not precisely describe the actual semantics and was unnecessarily emotion-laden. <a id="DEP0008"></a> diff --git a/doc/api/errors.md b/doc/api/errors.md index eb8558ae5a0..51057558fc4 100644 --- a/doc/api/errors.md +++ b/doc/api/errors.md @@ -894,7 +894,6 @@ installed. [domains]: domain.html [event emitter-based]: events.html#events_class_eventemitter [file descriptors]: https://en.wikipedia.org/wiki/File_descriptor -[intl wiki]: https://github.com/nodejs/node/wiki/Intl [online]: http://man7.org/linux/man-pages/man3/errno.3.html [stream-based]: stream.html [syscall]: http://man7.org/linux/man-pages/man2/syscall.2.html |