Skip to content

docs: fix inaccurate comment on Rule's recommended property #7324

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 1 commit into from
Jul 27, 2023
Merged

Conversation

Zamiell
Copy link
Contributor

@Zamiell Zamiell commented Jul 26, 2023

PR Checklist

Overview

fixes bad comment

@typescript-eslint
Copy link
Contributor

Thanks for the PR, @Zamiell!

typescript-eslint is a 100% community driven project, and we are incredibly grateful that you are contributing to that community.

The core maintainers work on this in their personal time, so please understand that it may not be possible for them to review your work immediately.

Thanks again!


🙏 Please, if you or your company is finding typescript-eslint valuable, help us sustain the project by sponsoring it transparently on https://opencollective.com/typescript-eslint.

@netlify
Copy link

netlify bot commented Jul 26, 2023

Deploy Preview for typescript-eslint ready!

Name Link
🔨 Latest commit 28f3031
🔍 Latest deploy log https://app.netlify.com/sites/typescript-eslint/deploys/64c1706740917c00083b7179
😎 Deploy Preview https://deploy-preview-7324--typescript-eslint.netlify.app
📱 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.

@nx-cloud
Copy link

nx-cloud bot commented Jul 26, 2023

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 28f3031. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this branch


✅ Successfully ran 35 targets

Sent with 💌 from NxCloud.

@JoshuaKGoldberg JoshuaKGoldberg changed the title fix: bad comment docs: fix inaccurate comment on Rule's recommended property Jul 27, 2023
Copy link
Member

@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.

Super, thanks @Zamiell! A perfect code change. 💯

Note that I updated the PR title:

  • This is a docs issue, not a runtime code change
  • Specific PR titles are better to help folks spelunk through the PRs queue and/or history

@JoshuaKGoldberg JoshuaKGoldberg merged commit 36a1fc3 into typescript-eslint:main Jul 27, 2023
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 4, 2023
@Zamiell Zamiell deleted the fix branch September 17, 2023 13:30
@Zamiell Zamiell restored the fix branch September 17, 2023 13:31
@Zamiell Zamiell deleted the fix branch September 17, 2023 13:31
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Bug: recommended prop typo
2 participants