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.

Sign up for GitHub

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

Jump to bottom

Docs: Add descriptions to rule schema options #5392

Open
2 tasks done
JoshuaKGoldberg opened this issue Jul 28, 2022 · 0 comments
Open
2 tasks done

Docs: Add descriptions to rule schema options #5392

JoshuaKGoldberg opened this issue Jul 28, 2022 · 0 comments
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

JoshuaKGoldberg commented Jul 28, 2022 •
edited

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

Suggested Changes

From discussion in #5058 (comment) and #5386 (comment) & #5386 (comment): it'd be great to use JSON schema description fields on rule options per https://json-schema.org/draft/2020-12/json-schema-core.html#name-schema-vocabularies. That way auto-generated rule docs (#5058) will be more informative.

This will likely involve turning a lot of type string literal union types into enums.

Affected URL(s)

http://typescript-eslint.io/rules/*
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
accepting prs Go ahead, send a pull request that resolves this issue documentation Documentation ("docs") that needs adding/updating
Projects
No open projects
Documentation
Status: Todo
Milestone
No milestone
Development

No branches or pull requests
1 participant
@JoshuaKGoldberg