Documentation could indicate usage

Hi!

I’m using eslint and I’m loving it! Thanks!

However, every time I go to some rule page (this time it was: https://eslint.org/docs/rules/guard-for-in), I can’t find enough information to know how to add this rule to my eslint config.

Yes, I’m a total beginner and I’d love to have a tiny little code snippet showing me exactly where and how to add it (remember webpack configs pre v3? #tappingInTheDarkCopyPastingRules)

I think this short code snippet wouldn’t bloat the pages in any way, but would be super useful to “not have to think”:

rules: {
  // ...
  'guard-for-in': 1,
}

Especially since eslint rules’ values are not necessarily always a simple true/false. It would be great to specify which values each rule accepts.

Thanks!

[platinumazure]

Could this be added to the template/layout for the rule pages, so that we don’t have to update all the rule pages one by one?

That sounds feasible!

[eslint-deprecated[bot]]

Unfortunately, it looks like there wasn’t enough interest from the team or community to implement this change. While we wish we’d be able to accommodate everyone’s requests, we do need to prioritize. We’ve found that issues failing to reach accepted status after 21 days tend to never be accepted, and as such, we close those issues. This doesn’t mean the idea isn’t interesting or useful, just that it’s not something the team can commit to.

Thanks for contributing to ESLint and we appreciate your understanding.