-
Notifications
You must be signed in to change notification settings - Fork 32.9k
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
fix: update README.md small typo #1381
base: master
Are you sure you want to change the base?
Conversation
WalkthroughThis pull request updates the README file by correcting the wording in a tutorial description for a TypeScript resource. The verb form was changed from "Learns" to "Learn," resulting in a grammatically consistent description. No alterations were made to any exported or public entities. Changes
Poem
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (1)
README.md (1)
472-472
: Typo Correction Verified:
The change from "Learns" to "Learn" correctly fixes the grammatical error in the tutorial description for the TypeScript resource.Nitpick - Emphasis Style Consistency:
The static analysis hints note that underscores (_
) are used for emphasis on this line instead of asterisks (*
), which is the recommended style (MD049). Consider updating the emphasis to maintain consistency with the style guidelines. For example, change:-* [**TypeScript**: _Tiny Package Manager: Learn how npm or Yarn works_](https://github.com/g-plane/tiny-package-manager) +* [**TypeScript**: *Tiny Package Manager: Learn how npm or Yarn works*](https://github.com/g-plane/tiny-package-manager)🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
472-472: Emphasis style
Expected: asterisk; Actual: underscore(MD049, emphasis-style)
472-472: Emphasis style
Expected: asterisk; Actual: underscore(MD049, emphasis-style)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md
(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
README.md
472-472: Emphasis style
Expected: asterisk; Actual: underscore
(MD049, emphasis-style)
472-472: Emphasis style
Expected: asterisk; Actual: underscore
(MD049, emphasis-style)
Summary by CodeRabbit