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: tweak explanation for meta.docs rule properties #18057

Merged
merged 1 commit into from Jan 31, 2024

Conversation

bmish
Copy link
Sponsor Member

@bmish bmish commented Jan 31, 2024

Prerequisites checklist

What is the purpose of this pull request? (put an "X" next to an item)

[x] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofix to a rule
[ ] Add a CLI option
[ ] Add something to the core
[ ] Other, please explain:

What changes did you make? (Give an overview)

Clarify the difference between how rule meta.docs properties are used for core rules and custom rules.

This just tweaks the wording to clarify how these properties are used today.

Semi-related issue: #17842

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

@bmish bmish requested a review from a team as a code owner January 31, 2024 17:40
@eslint-github-bot eslint-github-bot bot added the documentation Relates to ESLint's documentation label Jan 31, 2024
Copy link

netlify bot commented Jan 31, 2024

Deploy Preview for docs-eslint ready!

Name Link
🔨 Latest commit 3a320cd
🔍 Latest deploy log https://app.netlify.com/sites/docs-eslint/deploys/65ba860618ea6b000801bc45
😎 Deploy Preview https://deploy-preview-18057--docs-eslint.netlify.app/extend/custom-rules
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

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.

@nzakas nzakas merged commit 857e242 into eslint:main Jan 31, 2024
18 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Relates to ESLint's documentation
Projects
Status: Complete
Development

Successfully merging this pull request may close these issues.

None yet

2 participants