[doc] fix ordered list #20749
[doc] fix ordered list #20749
Conversation
Signed-off-by: reidliu41 <reid201711@gmail.com>
|
👋 Hi! Thank you for contributing to the vLLM project. 💬 Join our developer Slack at https://slack.vllm.ai to discuss your PR in #pr-reviews, coordinate on features in #feat- channels, or join special interest groups in #sig- channels. Just a reminder: PRs would not trigger full CI run by default. Instead, it would only run Once the PR is approved and ready to go, your PR reviewer(s) can run CI to test the changes comprehensively before merging. To run CI, PR reviewers can either: Add 🚀 |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @reidliu41, 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 improving the readability and visual appeal of the documentation, specifically addressing the formatting of ordered lists and code snippets in the incremental_build.md file. The changes ensure that the documentation is clear and easy to follow for users.
Highlights
- Documentation Fix: Corrected the formatting of ordered lists in the
incremental_build.mddocumentation file. - Readability: Improved the visual presentation of CMake commands within the documentation by adjusting indentation.
Using Gemini Code Assist
The 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 in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
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 .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and 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 to provide feedback.
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
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
The pull request fixes the formatting of ordered lists in the incremental_build.md documentation file by adjusting the indentation of code blocks within the numbered steps. The indentation is adjusted to be consistent with the surrounding text.
| ```console | ||
| cmake --preset release | ||
| ``` |
There was a problem hiding this comment.
The indentation for the code block should be consistent with the surrounding text. It's recommended to use a single indentation level (e.g., two spaces) for better readability.
| ```console | |
| cmake --preset release | |
| ``` | |
| ```console | |
| cmake --preset release |
| ```console | ||
| cmake --build --preset release --target install | ||
| ``` |
There was a problem hiding this comment.
The indentation for the code block should be consistent with the surrounding text. It's recommended to use a single indentation level (e.g., two spaces) for better readability.
| ```console | |
| cmake --build --preset release --target install | |
| ``` | |
| ```console | |
| cmake --build --preset release --target install |
Signed-off-by: reidliu41 <reid201711@gmail.com>
Signed-off-by: reidliu41 <reid201711@gmail.com>
Signed-off-by: reidliu41 <reid201711@gmail.com> Signed-off-by: Jinzhen Lin <linjinzhen@hotmail.com>
Signed-off-by: reidliu41 <reid201711@gmail.com> Signed-off-by: Diego-Castan <diego.castan@ibm.com>
Signed-off-by: reidliu41 <reid201711@gmail.com>
3 participants
Essential Elements of an Effective PR Description Checklist
supported_models.mdandexamplesfor a new model.Purpose
from:
to:
Test Plan
Test Result
(Optional) Documentation Update