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

Update default rule doc title format and show description notice by default #347

Open
nzakas opened this issue Dec 14, 2022 · 1 comment
Labels
Milestone

Comments

@nzakas
Copy link

nzakas commented Dec 14, 2022

Right now, the main title on each rule page is the old ESLint format of "description (rule-id)", which can be quite long.

The ESLint docs switched to having the rule-id as the primary heading with the description underneath it, so I'd like to see this change here as well.

@bmish bmish added the enhancement New feature or request label Dec 14, 2022
@bmish
Copy link
Owner

bmish commented Dec 14, 2022

One note is that we do have an option --rule-doc-title-format to control the title format. I would be open to changing the default to prefix-name in a future major version, since I agree that would make the title simpler and more concise.

As for the description, we need to implement a NOTICE_TYPE to include the description under the title. This would enable us to ensure we still include the description even after a change to the default title format. Done in: #350.

@bmish bmish added this to the v2.0.0 milestone Dec 15, 2022
@bmish bmish added the breaking label Dec 15, 2022
@bmish bmish changed the title Update title format Update default rule doc title format Dec 16, 2022
@bmish bmish removed the enhancement New feature or request label Dec 16, 2022
@bmish bmish changed the title Update default rule doc title format Update default rule doc title format and show description notice by default Dec 16, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants