diff options
| author | Anna Henningsen <anna@addaleax.net> | 2017-07-18 21:12:19 +0300 |
|---|---|---|
| committer | Jeremiah Senkpiel <fishrock123@rocketmail.com> | 2017-07-19 22:03:02 +0300 |
| commit | 64867a9c3b0194500ded9b7440d0dd70cfd1ec60 (patch) | |
| tree | 8940f7b8850c010ab1f32d0ebde32cddaae2fd93 | |
| parent | 740ab3d0cbdb535e56399318f1bae77dd694b7b6 (diff) | |
doc: fix inspectPort documentation in cluster.md
- Add missing `changes:` entry
- Use full sentences
- Use proper indentation
Ref: https://github.com/nodejs/node/pull/14140
PR-URL: https://github.com/nodejs/node/pull/14349
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
| -rw-r--r-- | doc/api/cluster.md | 8 |
1 files changed, 6 insertions, 2 deletions
diff --git a/doc/api/cluster.md b/doc/api/cluster.md index 20839367467..b439bd6bcd1 100644 --- a/doc/api/cluster.md +++ b/doc/api/cluster.md @@ -728,6 +728,9 @@ values are `"rr"` and `"none"`. <!-- YAML added: v0.7.1 changes: + - version: REPLACEME + pr-url: https://github.com/nodejs/node/pull/14140 + description: The `inspectPort` option is supported now. - version: v6.4.0 pr-url: https://github.com/nodejs/node/pull/7838 description: The `stdio` option is supported now. @@ -747,8 +750,9 @@ changes: * `uid` {number} Sets the user identity of the process. (See setuid(2).) * `gid` {number} Sets the group identity of the process. (See setgid(2).) * `inspectPort` {number|function} Sets inspector port of worker. - Accepts number, or function that evaluates to number. By default - each worker gets port, incremented from master's `process.debugPort`. + This can be a number, or a function that takes no arguments and returns a + number. By default each worker gets its own port, incremented from the + master's `process.debugPort`. After calling `.setupMaster()` (or `.fork()`) this settings object will contain the settings, including the default values. |