Skip to content

Tweak fixable documentation link #118

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

Merged
merged 5 commits into from
Oct 12, 2022
Merged

Tweak fixable documentation link #118

merged 5 commits into from
Oct 12, 2022

Conversation

MichaelDeBoey
Copy link
Contributor

@MichaelDeBoey MichaelDeBoey commented Oct 11, 2022

We're taking about the --fix flag, so maybe we should just link to it's docs right away?

README.md Outdated
@@ -61,7 +61,7 @@ Generated content in a rule doc (everything above the marker comment):

💼 This rule is enabled in the following configs: `all`, ✅ `recommended`.

🔧 This rule is automatically fixable by the `--fix` [CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
🔧 This rule is automatically fixable by [the `--fix` CLI option](https://eslint.org/docs/user-guide/command-line-interface#--fix).
Copy link
Owner

Choose a reason for hiding this comment

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

Can we exclude the from the link? I don't think that needs to be part of it.

I actually got some similar feedback in this comment: sindresorhus/eslint-plugin-unicorn#1930 (comment)

@bmish
Copy link
Owner

bmish commented Oct 11, 2022

You'll also need to update the text here:

[MESSAGE_TYPE.FIXABLE]: `${EMOJI_FIXABLE} This rule is automatically fixable by the \`--fix\` [CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).`,

@bmish bmish added the bug Something isn't working label Oct 11, 2022
@bmish
Copy link
Owner

bmish commented Oct 11, 2022

And run npm test to update the snapshots.

@bmish bmish changed the title chore: update fixable legend Tweak fixable documentation link Oct 12, 2022
Copy link
Owner

@bmish bmish left a comment

Choose a reason for hiding this comment

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

Thanks!

@bmish bmish merged commit 30f5184 into bmish:main Oct 12, 2022
@MichaelDeBoey MichaelDeBoey deleted the patch-1 branch October 14, 2022 21:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants