[Doc] Add code example of how to use custom filters #268
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.
Description
Yesterday I tried to use a custom filter but couldn't get it to work. I looked in the documentation and example code but found no information about this, so I read the source code and figured out that I had to call the
FilterRule
method. Upon reflection, this design makes sense and feels natural but I think it would be good to have an example in the readme.Changes Made
FilterRule
call in the readme'sAdd Custom Filter
section.