Skip to content
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

Docs: Enforce that every rule and rule option has ❌ Incorrect and ✅ Correct examples #8154

Open
2 tasks done
JoshuaKGoldberg opened this issue Dec 29, 2023 · 0 comments
Open
2 tasks done
Labels
accepting prs Go ahead, send a pull request that resolves this issue documentation Documentation ("docs") that needs adding/updating

Comments

@JoshuaKGoldberg
Copy link
Member

Before You File a Documentation Request Please Confirm You Have Done The Following...

Suggested Changes

Following up on #8014 -> #8015 and #8014 (comment):

Just had an idea: as a follow-up to this, we could also enforce that every rule option has an ❌ Incorrect / ✅ Correct tab group, the way many do in docs today...

I think this'd be very helpful for making sure every rule option is quickly comprehensible.

Affected URL(s)

https://typescript-eslint.io/rules/*

@JoshuaKGoldberg JoshuaKGoldberg added triage Waiting for maintainers to take a look documentation Documentation ("docs") that needs adding/updating labels Dec 29, 2023
@JoshuaKGoldberg JoshuaKGoldberg added accepting prs Go ahead, send a pull request that resolves this issue and removed triage Waiting for maintainers to take a look labels Jan 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
accepting prs Go ahead, send a pull request that resolves this issue documentation Documentation ("docs") that needs adding/updating
Projects
None yet
Development

No branches or pull requests

1 participant