Commit ef74368
committed
doc: fix heading of optional console method args
PR-URL: #21311
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: James M Snell <jasnell@gmail.com>1 parent 4f17841 commit ef74368
1 file changed
Lines changed: 11 additions & 8 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -164,7 +164,7 @@ operates similarly to the `clear` shell command. On Windows, `console.clear()` | |||
| 164 | 164 | will clear only the output in the current terminal viewport for the Node.js | |
| 165 | 165 | binary. | |
| 166 | 166 | ||
| 167 | - ### console.count([label='default']) | ||
| 167 | + ### console.count([label]) | ||
| 168 | 168 | <!-- YAML | |
| 169 | 169 | added: v8.3.0 | |
| 170 | 170 | --> | |
@@ -197,7 +197,7 @@ undefined | |||
| 197 | 197 | > | |
| 198 | 198 | ``` | |
| 199 | 199 | ||
| 200 | - ### console.countReset([label='default']) | ||
| 200 | + ### console.countReset([label]) | ||
| 201 | 201 | <!-- YAML | |
| 202 | 202 | added: v8.3.0 | |
| 203 | 203 | --> | |
@@ -381,7 +381,7 @@ console.table([{ a: 1, b: 'Y' }, { a: 'Z', b: 2 }], ['a']); | |||
| 381 | 381 | // └─────────┴─────┘ | |
| 382 | 382 | ``` | |
| 383 | 383 | ||
| 384 | - ### console.time(label) | ||
| 384 | + ### console.time([label]) | ||
| 385 | 385 | <!-- YAML | |
| 386 | 386 | added: v0.1.104 | |
| 387 | 387 | --> | |
@@ -392,7 +392,7 @@ are identified by a unique `label`. Use the same `label` when calling | |||
| 392 | 392 | [`console.timeEnd()`][] to stop the timer and output the elapsed time in | |
| 393 | 393 | milliseconds to `stdout`. Timer durations are accurate to the sub-millisecond. | |
| 394 | 394 | ||
| 395 | - ### console.timeEnd(label) | ||
| 395 | + ### console.timeEnd([label]) | ||
| 396 | 396 | <!-- YAML | |
| 397 | 397 | added: v0.1.104 | |
| 398 | 398 | changes: | |
@@ -453,7 +453,7 @@ The following methods are exposed by the V8 engine in the general API but do | |||
| 453 | 453 | not display anything unless used in conjunction with the [inspector][] | |
| 454 | 454 | (`--inspect` flag). | |
| 455 | 455 | ||
| 456 | - ### console.markTimeline(label) | ||
| 456 | + ### console.markTimeline([label]) | ||
| 457 | 457 | <!-- YAML | |
| 458 | 458 | added: v8.0.0 | |
| 459 | 459 | --> | |
@@ -476,11 +476,11 @@ the **Profile** panel of the inspector. | |||
| 476 | 476 | ```js | |
| 477 | 477 | console.profile('MyLabel'); | |
| 478 | 478 | // Some code | |
| 479 | - console.profileEnd(); | ||
| 479 | + console.profileEnd('MyLabel'); | ||
| 480 | 480 | // Adds the profile 'MyLabel' to the Profiles panel of the inspector. | |
| 481 | 481 | ``` | |
| 482 | 482 | ||
| 483 | - ### console.profileEnd() | ||
| 483 | + ### console.profileEnd([label]) | ||
| 484 | 484 | <!-- YAML | |
| 485 | 485 | added: v8.0.0 | |
| 486 | 486 | --> | |
@@ -490,6 +490,9 @@ current JavaScript CPU profiling session if one has been started and prints | |||
| 490 | 490 | the report to the **Profiles** panel of the inspector. See | |
| 491 | 491 | [`console.profile()`][] for an example. | |
| 492 | 492 | ||
| 493 | + If this method is called without a label, the most recently started profile is | ||
| 494 | + stopped. | ||
| 495 | + | ||
| 493 | 496 | ### console.timeStamp([label]) | |
| 494 | 497 | <!-- YAML | |
| 495 | 498 | added: v8.0.0 | |
@@ -523,7 +526,7 @@ This method does not display anything unless used in the inspector. The | |||
| 523 | 526 | [`console.group()`]: #console_console_group_label | |
| 524 | 527 | [`console.log()`]: #console_console_log_data_args | |
| 525 | 528 | [`console.profile()`]: #console_console_profile_label | |
| 526 | - [`console.profileEnd()`]: #console_console_profileend | ||
| 529 | + [`console.profileEnd()`]: #console_console_profileend_label | ||
| 527 | 530 | [`console.time()`]: #console_console_time_label | |
| 528 | 531 | [`console.timeEnd()`]: #console_console_timeend_label | |
| 529 | 532 | [`console.timeStamp()`]: #console_console_timestamp_label | |
0 commit comments