Documentation could indicate usage
See original GitHub issueHi!
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!
Issue Analytics
- State:
- Created 5 years ago
- Comments:7 (4 by maintainers)
Top Results From Across the Web
Document indicates definition and meaning - Collins Dictionary
Document indicates definition: A document is one or more official pieces of paper with writing on them. [...] | Meaning, pronunciation, translations and ......
Read more >Importance of Documentation | The Workstream - Atlassian
With documentation in place, you can refer to past work and learn from it, instead of doing it all over again with the...
Read more >HR Documentation: A Complete Guide (With Best Practices)
This documentation typically includes records of employment, information about company actions and incident reports. Federal and local law may ...
Read more >What is Software Documentation? Definition, Types and ...
In the software development process, software documentation is the information that describes the product to the people who develop, deploy and use it....
Read more >Documentation Definition & Meaning - Merriam-Webster
The meaning of DOCUMENTATION is the act or an instance of furnishing or authenticating with documents. How to use documentation in a ...
Read more >Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start FreeTop Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Top GitHub Comments
That sounds feasible!
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.