docs: fix small typo in README (Checkout → Check out)#3800
docs: fix small typo in README (Checkout → Check out)#3800UziTech merged 1 commit intomarkedjs:masterfrom
Conversation
|
@Wangarijane is attempting to deploy a commit to the MarkedJS Team on Vercel. A member of the Team first needs to authorize it. |
Summary of ChangesHello @Wangarijane, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request focuses on a minor documentation improvement by correcting a grammatical error and a capitalization inconsistency within the project's README file. The changes enhance the readability and professional presentation of the project's introductory information. Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request corrects a grammatical error in README.md by changing 'Checkout' to 'Check out' and also improves consistency by capitalizing 'Marked'. These are good changes that improve the quality of the documentation. I have added one comment regarding a related consistency issue that could be addressed to make the document even better. Additionally, it would be helpful to update the pull request description to mention the capitalization change, so it fully reflects the scope of the changes.
| ## Demo | ||
|
|
||
| Checkout the [demo page](https://marked.js.org/demo/) to see marked in action ⛹️ | ||
| Check out the [demo page](https://marked.js.org/demo/) to see Marked in action ⛹️ |
There was a problem hiding this comment.
Capitalizing 'Marked' here is a good consistency improvement. To make it consistent throughout the file, please also capitalize 'marked' on line 24, which currently reads ...rendered using marked 💯.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
3 participants
Summary
This pull request fixes a small typo in the README file.
Change Details
"Checkout the demo page"→"Check out the demo page"for grammatical correctness.