Skip to content

Commit 289d0bf

Browse files
Trottcodebytere
authored andcommitted
doc: remove default parameter value from header
In the docs, we specify the default value of function parameters in the list below the header. There is one exception where we use default parameter notation. Change that instance to be like the rest of the docs instead. I rather like the default parameter notation, and I get why we didn't use it to begin with. (The notation didn't exist in JavaScript at the time.) I wouldn't mind switching to it, but that would result in big churn. That can be a separate topic of discussion. For now, though, let's get the docs consistent. PR-URL: #33752 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]>
1 parent 2f02fba commit 289d0bf

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

doc/api/cluster.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -415,13 +415,13 @@ if (cluster.isMaster) {
415415
}
416416
```
417417

418-
### `worker.kill([signal='SIGTERM'])`
418+
### `worker.kill([signal])`
419419
<!-- YAML
420420
added: v0.9.12
421421
-->
422422

423423
* `signal` {string} Name of the kill signal to send to the worker
424-
process.
424+
process. **Default**: `'SIGTERM'`
425425

426426
This function will kill the worker. In the master, it does this by disconnecting
427427
the `worker.process`, and once disconnected, killing with `signal`. In the

0 commit comments

Comments
 (0)