Skip to content

Commit b2d9689

Browse files
committed
Improve documentation
1 parent 87f053a commit b2d9689

File tree

2 files changed

+4
-3
lines changed

2 files changed

+4
-3
lines changed

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,8 @@ logProcessErrors(options)
8080
- [`level` `{object}`](docs/API.md#level): which log level to use. Default:
8181
`{ warning: 'warn', multipleResolves: 'info', default: 'error' }`.
8282
- [`message` `{function}`](docs/API.md#message): customize messages.
83-
- [`colors` `{boolean}`](docs/API.md#colors): colorize messages. Default: `true`.
83+
- [`colors` `{boolean}`](docs/API.md#colors): colorize messages. Default: `true`
84+
if the output is a terminal.
8485
- [`exitOn` `{string[]}`](docs/API.md#exiton): which events should trigger
8586
`process.exit(1)`. Default: `['uncaughtException']`.
8687

docs/API.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -95,8 +95,8 @@ Override the default message generation. Arguments are [`level`](#level),
9595
_Type_: `boolean`<br>
9696
_Default_: `true` if the output is a terminal.
9797

98-
Colorize the [`message`](#message). Does not do anything if the
99-
[`message`](#message) option is defined.
98+
Colorize messages. Does not do anything if the [`message`](#message) option is
99+
defined.
100100

101101
#### exitOn
102102

0 commit comments

Comments
 (0)