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

chore: add link to docs in each eslint rule #32

Merged
merged 1 commit into from
Dec 12, 2024

Conversation

k-yle
Copy link
Contributor

@k-yle k-yle commented Dec 11, 2024

Prerequisites checklist

What is the purpose of this pull request?

Improve the DX, particularly because many people expect eslint to only lint JS files. So making the docs easily accessible is important.

What changes did you make? (Give an overview)

Add docs.url to every rule, so that you can click on the rule in your IDE to go directly to the documentation

Related Issues

­-

Is there anything you'd like reviewers to focus on?

­-

Copy link
Member

@nzakas nzakas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Thanks.

Copy link
Member

@nzakas nzakas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

CI is failing because strings should use double quotes. Can you please update that?

@k-yle
Copy link
Contributor Author

k-yle commented Dec 11, 2024

done

Copy link
Member

@nzakas nzakas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks.

@nzakas nzakas merged commit 19ef47a into eslint:main Dec 12, 2024
16 checks passed
@k-yle k-yle deleted the kh/docs-link branch December 12, 2024 23:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants