Updated "Output options" > "comments" in README.md

Expanded the current documentation to include:

- What the value of `"some"` means based on `lib/output.js`.
- Information about the `Function` overload parameters and expected output.
This commit is contained in:
Marco Gonzalez 2020-02-12 17:01:26 -08:00 committed by GitHub
parent 83a42716c3
commit 3927415dde
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -848,8 +848,8 @@ can pass additional arguments that control the code output:
statement.
- `comments` (default `false`) -- pass `true` or `"all"` to preserve all
comments, `"some"` to preserve some comments, a regular expression string
(e.g. `/^!/`) or a function.
comments, `"some"` to preserve some comments (i.e. `/@preserve|@license|@cc_on/i`), a regular expression string
(e.g. `/^!/`), or a function that returns a *truthy/falsy* value that will be converted to `boolean` (e.g. `(_, comment) => preserveComment(comment.value)` where `preserveComment` is a user-defined function).
- `indent_level` (default `4`)