Skip to content

Commit

Permalink
Update documentation comment options (#444)
Browse files Browse the repository at this point in the history
  • Loading branch information
@avdg @vladikoff
avdg authored and vladikoff committed Oct 26, 2016
1 parent 60824c1 commit cc846ac
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion README.md
View file
Expand Up @@ -169,8 +169,9 @@ Turn on preservation of comments.


- `false` will strip all comments - `false` will strip all comments
- `'all'` will preserve all comments in code blocks that have not been squashed or dropped - `'all'` will preserve all comments in code blocks that have not been squashed or dropped
- `'some'` will preserve all comments that start with a bang (`!`) or include a closure compiler style directive (`@preserve` `@license` `@cc_on`) - `'some'` will preserve all comments that include a closure compiler style directive (`@preserve` `@license` `@cc_on`)
- `Function` specify your own comment preservation function. You will be passed the current node and the current comment and are expected to return either `true` or `false` - `Function` specify your own comment preservation function. You will be passed the current node and the current comment and are expected to return either `true` or `false`
- `RegExp` `'/[RegExp]/'` will preserve comments matching given RegExp or stringified RegExp


#### banner #### banner
Type: `String` Type: `String`
Expand Down

2 comments on commit cc846ac

@XhmikosR
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is wrong; the changes should be made in the docs folder.

Apart from that, tests broke. What is the equivalent of the old some option?

@XhmikosR
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Never mind, I went with 0511085

Please sign in to comment.