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

Closed
2 tasks done
JoshuaKGoldberg opened this issue Jul 28, 2022 · 0 comments · Fixed by #9868
Closed
2 tasks done

Docs: Add descriptions to rule schema options #5392

JoshuaKGoldberg opened this issue Jul 28, 2022 · 0 comments · Fixed by #9868
Labels
accepting prs Go ahead, send a pull request that resolves this issue documentation Documentation ("docs") that needs adding/updating locked due to age Please open a new issue if you'd like to say more. See https://typescript-eslint.io/contributing.

Comments

@JoshuaKGoldberg
Copy link
Member

JoshuaKGoldberg commented Jul 28, 2022 •
edited
Loading

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/*
@JoshuaKGoldberg JoshuaKGoldberg added documentation Documentation ("docs") that needs adding/updating accepting prs Go ahead, send a pull request that resolves this issue labels Jul 28, 2022
@JoshuaKGoldberg JoshuaKGoldberg mentioned this issue Jul 28, 2022
Merged
3 tasks
@JoshuaKGoldberg JoshuaKGoldberg mentioned this issue Oct 24, 2022
Merged
3 tasks
@JoshuaKGoldberg JoshuaKGoldberg mentioned this issue Dec 18, 2022
Closed
This was referenced Aug 23, 2024
Open
Closed
Merged
@abrahamguo abrahamguo mentioned this issue Aug 28, 2024
Closed
3 tasks
@github-project-automation github-project-automation bot moved this from Todo to Done in Documentation Aug 29, 2024
@github-actions github-actions bot added the locked due to age Please open a new issue if you'd like to say more. See https://typescript-eslint.io/contributing. label Sep 6, 2024
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Sep 6, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
accepting prs Go ahead, send a pull request that resolves this issue documentation Documentation ("docs") that needs adding/updating locked due to age Please open a new issue if you'd like to say more. See https://typescript-eslint.io/contributing.
Projects
No open projects
Documentation
Status: Done
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: fill in most remaining rule option descriptions JoshuaKGoldberg/typescript-eslint
1 participant
@JoshuaKGoldberg