Skip to content

Commit

Permalink
docs: fixed default value for comments option (#521)
Browse files Browse the repository at this point in the history
  • Loading branch information
sergei-startsev authored and fabiosantoscode committed Nov 25, 2019
1 parent 0ae57bd commit b66fd6b
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,7 @@ a double dash to prevent input files being used as option arguments:
"@preserve". You can optionally pass one of the
following arguments to this flag:
- "all" to keep all comments
- `false` to omit comments in the output
- a valid JS RegExp like `/foo/` or `/^!/` to
keep only matching comments.
Note that currently not *all* comments can be
Expand Down Expand Up @@ -975,8 +976,9 @@ can pass additional arguments that control the code output:
`do`, `while` or `with` statements, even if their body is a single
statement.

- `comments` (default `false`) -- pass `true` or `"all"` to preserve all
comments, `"some"` to preserve some comments, a regular expression string
- `comments` (default `"some"`) -- by default it keeps JSDoc-style comments
that contain "@license" or "@preserve", pass `true` or `"all"` to preserve all
comments, `false` to omit comments in the output, a regular expression string
(e.g. `/^!/`) or a function.

- `ecma` (default `5`) -- set output printing mode. Set `ecma` to `6` or
Expand Down

0 comments on commit b66fd6b

Please sign in to comment.