Rule documentation
Closed this issue · 1 comments
RinkAttendant6 commented
It would be nice to have some documentation on what each rule enforces, instead of checking all the files inside the tests/
directory.
A one-line description would suffice, for example, "Disallow use of $.trim
".
Even better would be examples of incorrect and correct code (ideally showing equivalent versions on how to correct the error).
dgraham commented
I prefer to rely on the thorough documentation at Mozilla Developer Network, for the native web platform API, and jQuery API so we don't need to duplicate it here.
When a lint rule is violated, it prints a message like Prefer addEventListener to $.bind
. Searching for mdn addEventListener and jquery bind finds great documentation.