-
-
Notifications
You must be signed in to change notification settings - Fork 2.8k
Rework template for individual Rules pages #4365
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Comments
We used this style because it's the standard across the ESLint ecosystem. Examples: |
Oh that's very interesting. In general this is kind of a violation of what a heading is supposed to be, no? I don't know of any precedent for using the top level heading in a file to describe anything like this description. Is this exclusively in ESLint? |
I think the idea is that the title is kind of just the tagline for the rule to help people figure out what it does at a glance to save them reading the entire page? I'm not sure exactly! This convention came from people copying the ESLint core docs. |
Moved to ESLint core: eslint/eslint#15471 |
Per eslint/eslint#15471 I think we can consider this accepting PRs! 🙌 |
Right now individual rules' pages have a somewhat unwieldy header based on their description. I'd like to swap that with a header equal to the rule name, and move that description into body text.
It'd be nice to also auto-generated an ESLint config snippet for enabling the rule...
The text was updated successfully, but these errors were encountered: