I think docs for each linter should have an examples section with at least one example of code that does produce lint and another that doesn't.
I think the style guide is good to provide the underlying rationale for the lint (provided that the reader actually clicks on that link!), but it doesn't lead to much exploration on the reader's part. Giving concrete examples means that the reader can just copy-paste examples and start toying around with them to see what does and doesn't lint.
Note to self: Make sure all of them follow the style guide, and so use " instead of ', e.g.
Progress tracker
I think docs for each linter should have an examples section with at least one example of code that does produce lint and another that doesn't.
I think the style guide is good to provide the underlying rationale for the lint (provided that the reader actually clicks on that link!), but it doesn't lead to much exploration on the reader's part. Giving concrete examples means that the reader can just copy-paste examples and start toying around with them to see what does and doesn't lint.
Note to self: Make sure all of them follow the style guide, and so use
"instead of', e.g.Progress tracker