And as a quick follow-up, I’d also love to add 2 pieces of information to each rule documentation:
1. Whether it is on or off by default (and possible options for rules that have options) 2. The error message the rule will produce when triggered I’ll often get an error and not know what rule is triggering it until I search through the ESLint codebase. Best, Ian On Dec 20, 2013, at 10:47 AM, Ian Christian Myers <[email protected]> wrote: > Can you give an example of a rule that has good documentation that can be > used as a example? > > Also, I find that with some of the rules the documentation becomes repetitive > because the format calls for prose in two places—at the beginning as an > overview of the rule and the justification for it and then again after the > first example where it seems like you're supposed to talk about the specific > cases when the rule will of will not warn/error. Would you be open to > iterating on the documentation format? Perhaps simplifying the format into > one explanatory paragraph followed by some better, more real-world examples > of the error and the best way to re-write to avoid the error? > — > Sent from Mailbox for iPhone > > > On Fri, Dec 20, 2013 at 10:29 AM, Nicholas Zakas <[email protected]> > wrote: > > Hi all, > > Just a heads up. I've been going through the rule documentation and we have > some pretty lousy documentation on a fair number of rules. As such, I'm going > to be much more strict about the documentation that's accepted with rules. > One of the things that is going to set ESLint apart from JSHint and JSLint is > that we are going to have mountains of useful documentation. > > Just FYI. :) > > -- > > ______________________________ > Nicholas C. Zakas > @slicknet > > Author, Professional JavaScript for Web Developers > Buy it at Amazon.com: > http://www.amazon.com/Professional-JavaScript-Developers-Nicholas-Zakas/dp/1118026691/ref=sr_1_3 > > -- > You received this message because you are subscribed to the Google Groups > "ESLint" group. > To unsubscribe from this group and stop receiving emails from it, send an > email to [email protected]. > For more options, visit https://groups.google.com/groups/opt_out. > -- You received this message because you are subscribed to the Google Groups "ESLint" group. To unsubscribe from this group and stop receiving emails from it, send an email to [email protected]. For more options, visit https://groups.google.com/groups/opt_out.
