Skip to content

Commit 60aaf2c

Browse files
committed
doc: fix nits in report docs
* Fix heading levels. * Fix section sorting. * Add quotes around string values. * Remove quotes around property names. PR-URL: #26461 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Colin Ihrig <[email protected]>
1 parent 69906fb commit 60aaf2c

File tree

2 files changed

+23
-23
lines changed

2 files changed

+23
-23
lines changed

doc/api/process.md

+21-21
Original file line numberDiff line numberDiff line change
@@ -1669,7 +1669,7 @@ added: v11.8.0
16691669
reports for the current process. Additional documentation is available in the
16701670
[report documentation][].
16711671

1672-
## process.report.directory
1672+
### process.report.directory
16731673
<!-- YAML
16741674
added: REPLACEME
16751675
-->
@@ -1684,6 +1684,21 @@ Node.js process.
16841684
console.log(`Report directory is ${process.report.directory}`);
16851685
```
16861686

1687+
### process.report.filename
1688+
<!-- YAML
1689+
added: REPLACEME
1690+
-->
1691+
1692+
* {string}
1693+
1694+
Filename where the report is written. If set to the empty string, the output
1695+
filename will be comprised of a timestamp, PID, and sequence number. The default
1696+
value is the empty string.
1697+
1698+
```js
1699+
console.log(`Report filename is ${process.report.filename}`);
1700+
```
1701+
16871702
### process.report.getReport([err])
16881703
<!-- YAML
16891704
added: v11.8.0
@@ -1702,22 +1717,7 @@ console.log(data);
17021717

17031718
Additional documentation is available in the [report documentation][].
17041719

1705-
## process.report.filename
1706-
<!-- YAML
1707-
added: REPLACEME
1708-
-->
1709-
1710-
* {string}
1711-
1712-
Filename where the report is written. If set to the empty string, the output
1713-
filename will be comprised of a timestamp, PID, and sequence number. The default
1714-
value is the empty string.
1715-
1716-
```js
1717-
console.log(`Report filename is ${process.report.filename}`);
1718-
```
1719-
1720-
## process.report.reportOnFatalError
1720+
### process.report.reportOnFatalError
17211721
<!-- YAML
17221722
added: REPLACEME
17231723
-->
@@ -1731,7 +1731,7 @@ memory errors or failed C++ assertions.
17311731
console.log(`Report on fatal error: ${process.report.reportOnFatalError}`);
17321732
```
17331733

1734-
## process.report.reportOnSignal
1734+
### process.report.reportOnSignal
17351735
<!-- YAML
17361736
added: REPLACEME
17371737
-->
@@ -1745,7 +1745,7 @@ signal specified by `process.report.signal`.
17451745
console.log(`Report on signal: ${process.report.reportOnSignal}`);
17461746
```
17471747

1748-
## process.report.reportOnUncaughtException
1748+
### process.report.reportOnUncaughtException
17491749
<!-- YAML
17501750
added: REPLACEME
17511751
-->
@@ -1758,15 +1758,15 @@ If `true`, a diagnostic report is generated on uncaught exception.
17581758
console.log(`Report on exception: ${process.report.reportOnUncaughtException}`);
17591759
```
17601760

1761-
## process.report.signal
1761+
### process.report.signal
17621762
<!-- YAML
17631763
added: REPLACEME
17641764
-->
17651765

17661766
* {string}
17671767

17681768
The signal used to trigger the creation of a diagnostic report. Defaults to
1769-
`SIGUSR2`.
1769+
`'SIGUSR2'`.
17701770

17711771
```js
17721772
console.log(`Report signal: ${process.report.signal}`);

doc/api/report.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -503,7 +503,7 @@ to intercept external triggers for report generation. Defaults to
503503
`filename` specifies the name of the output file in the file system.
504504
Special meaning is attached to `stdout` and `stderr`. Usage of these
505505
will result in report being written to the associated standard streams.
506-
In cases where standard streams are used, the value in `'directory'` is ignored.
506+
In cases where standard streams are used, the value in `directory` is ignored.
507507
URLs are not supported. Defaults to a composite filename that contains
508508
timestamp, PID and sequence number.
509509

@@ -522,7 +522,7 @@ process.report.reportOnFatalError = true;
522522
process.report.reportOnSignal = true;
523523
process.report.reportOnUncaughtException = false;
524524

525-
// Change the default signal to `SIGQUIT` and enable it.
525+
// Change the default signal to 'SIGQUIT' and enable it.
526526
process.report.reportOnFatalError = false;
527527
process.report.reportOnUncaughtException = false;
528528
process.report.reportOnSignal = true;

0 commit comments

Comments
 (0)