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: link from --fix CLI doc to the relevant core concept #18080

Merged
merged 1 commit into from Feb 4, 2024

Conversation

bmish
Copy link
Sponsor Member

@bmish bmish commented Feb 3, 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)

Update the --fix CLI doc to link to the core concept doc on fixability.

Ideally, one doc on a topic links to the other docs on the same topic, so users can find all relevant context.

Inspired by:

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

@bmish bmish requested a review from a team as a code owner February 3, 2024 22:25
@eslint-github-bot eslint-github-bot bot added the documentation Relates to ESLint's documentation label Feb 3, 2024
Copy link

netlify bot commented Feb 3, 2024

Deploy Preview for docs-eslint ready!

Name Link
🔨 Latest commit dc6e3c6
🔍 Latest deploy log https://app.netlify.com/sites/docs-eslint/deploys/65bebd584ac8b90008ec3b40
😎 Deploy Preview https://deploy-preview-18080--docs-eslint.netlify.app/use/command-line-interface
📱 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.

@bmish bmish changed the title docs: link from fix CLI doc to core concept docs: link from --fix CLI doc to the relevant core concept Feb 3, 2024
Copy link
Contributor

@JoshuaKGoldberg JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

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

I agree 🙂

@amareshsm amareshsm added the accepted There is consensus among the team that this change meets the criteria for inclusion label Feb 4, 2024
Copy link
Member

@amareshsm amareshsm left a comment

Choose a reason for hiding this comment

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

LGTM. This is left open in case someone else would like to review it.

@aladdin-add aladdin-add merged commit 07a1ada into eslint:main Feb 4, 2024
18 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
accepted There is consensus among the team that this change meets the criteria for inclusion documentation Relates to ESLint's documentation
Projects
Status: Complete
Development

Successfully merging this pull request may close these issues.

None yet

4 participants