Updated "Output options" > "comments" in README.md #3717
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.
alexlamsl
requested changes
Feb 13, 2020
README.md
Outdated
| 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). |
There was a problem hiding this comment.
Looks good with two minor requests:
- please format to ~80 characters per line
- please use non-ES6 syntax for the function example, i.e.
function(node, comment) {
return comment.value.indexOf("@type " + node.TYPE) >= 0;
}There was a problem hiding this comment.
Oh and comments="some" only preserve multi-line comments that also matches the RegExp pattern, e.g. //@preserve will not be retained whilst /*@preserve*/ would.
alexlamsl
approved these changes
Feb 15, 2020
|
Thanks for improving documentation 👍 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Expanded the current documentation to include:
"some"means based onlib/output.js.Functionoverload parameters and expected output.