From 3927415dde207f727a7d6602dd32c1954a8f320c Mon Sep 17 00:00:00 2001 From: Marco Gonzalez Date: Wed, 12 Feb 2020 17:01:26 -0800 Subject: [PATCH] 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. --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 21dfabf9..e0129157 100644 --- a/README.md +++ b/README.md @@ -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`)