Browse Source

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>
v6
Daijiro Wachi 8 years ago
parent
commit
8b2c61c169
  1. 2
      doc/api/cluster.md
  2. 2
      doc/api/deprecations.md
  3. 1
      doc/api/errors.md

2
doc/api/cluster.md

@ -334,7 +334,7 @@ added: v6.0.0
Set by calling `.kill()` or `.disconnect()`. Until then, it is `undefined`. 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 voluntary and accidental exit, the master may choose not to respawn a worker
based on this value. based on this value.

2
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 `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 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 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. precisely describe the actual semantics and was unnecessarily emotion-laden.
<a id="DEP0008"></a> <a id="DEP0008"></a>

1
doc/api/errors.md

@ -894,7 +894,6 @@ installed.
[domains]: domain.html [domains]: domain.html
[event emitter-based]: events.html#events_class_eventemitter [event emitter-based]: events.html#events_class_eventemitter
[file descriptors]: https://en.wikipedia.org/wiki/File_descriptor [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 [online]: http://man7.org/linux/man-pages/man3/errno.3.html
[stream-based]: stream.html [stream-based]: stream.html
[syscall]: http://man7.org/linux/man-pages/man2/syscall.2.html [syscall]: http://man7.org/linux/man-pages/man2/syscall.2.html

Loading…
Cancel
Save