Commit 289d0bf
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 <anna@addaleax.net>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>1 parent 2f02fba commit 289d0bf
1 file changed
Lines changed: 2 additions & 2 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -415,13 +415,13 @@ if (cluster.isMaster) { | |||
| 415 | 415 | } | |
| 416 | 416 | ``` | |
| 417 | 417 | ||
| 418 | - ### `worker.kill([signal='SIGTERM'])` | ||
| 418 | + ### `worker.kill([signal])` | ||
| 419 | 419 | <!-- YAML | |
| 420 | 420 | added: v0.9.12 | |
| 421 | 421 | --> | |
| 422 | 422 | ||
| 423 | 423 | * `signal` {string} Name of the kill signal to send to the worker | |
| 424 | - process. | ||
| 424 | + process. **Default**: `'SIGTERM'` | ||
| 425 | 425 | ||
| 426 | 426 | This function will kill the worker. In the master, it does this by disconnecting | |
| 427 | 427 | the `worker.process`, and once disconnected, killing with `signal`. In the | |
0 commit comments