Skip to content

[doc] fix the incorrect label #19787

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
Jun 18, 2025

Conversation

reidliu41
Copy link
Contributor

@reidliu41 reidliu41 commented Jun 18, 2025

Essential Elements of an Effective PR Description Checklist

  • The purpose of the PR, such as "Fix some issue (link existing issues this PR will resolve)".
  • The test plan, such as providing test command.
  • The test results, such as pasting the results comparison before and after, or e2e results
  • (Optional) The necessary documentation update, such as updating supported_models.md and examples for a new model.

Purpose

It should set-up-using-python in docs/getting_started/installation/gpu/cuda.inc.md.

From:
image

to:
image

Test Plan

Test Result

(Optional) Documentation Update

Signed-off-by: reidliu41 <reid201711@gmail.com>
@reidliu41 reidliu41 requested a review from hmellor as a code owner June 18, 2025 04:34
Copy link

👋 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 fastcheck CI which starts running only a small and essential subset of CI tests to quickly catch errors. You can run other CI tests on top of those by going to your fastcheck build on Buildkite UI (linked in the PR checks section) and unblock them. If you do not have permission to unblock, ping simon-mo or khluu to add you in our Buildkite org.

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 ready label to the PR or enable auto-merge.

🚀

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

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 addresses a minor documentation issue by fixing an incorrect internal label reference. The change ensures that the 'NVIDIA CUDA' installation instructions correctly embed the intended 'set up using Python' section, improving the accuracy and consistency of the documentation for users.

Highlights

  • Documentation Link Correction: Corrected an internal documentation link in docs/getting_started/installation/gpu.md on line 45. The reference for the 'NVIDIA CUDA' installation section now correctly points to set-up-using-python instead of create-a-new-python-environment within cuda.inc.md.
  • Content Alignment: Removed a redundant heading ### Create a new Python environment from docs/getting_started/installation/gpu/cuda.inc.md on line 13. This change aligns the content with the updated internal reference label set-up-using-python, ensuring consistency and preventing potential issues with the documentation build process.
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

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

@mergify mergify bot added the documentation Improvements or additions to documentation label Jun 18, 2025
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request effectively corrects an issue in the GPU installation documentation, enhancing its accuracy and clarity.

Key changes include:

  • In docs/getting_started/installation/gpu.md, an incorrect content inclusion anchor was updated. The change from a non-existent anchor (create-a-new-python-environment) to the correct one (set-up-using-python) resolves what was likely a broken section in the rendered documentation.
  • In docs/getting_started/installation/gpu/cuda.inc.md, a redundant ### Create a new Python environment heading was removed. This is an appropriate cleanup, preventing duplication as a similar heading already exists in the parent document where this content is included.

Both changes are beneficial and improve the documentation.

For future PRs, consider enhancing the pull request description by:

  • More clearly articulating the problem being solved (e.g., detailing that the original anchor was non-existent and its impact).
  • Completing the checklist items in the PR template (Purpose, Test Plan, Test Results). For documentation changes, a 'Test Plan' could involve verifying the locally rendered output, and 'Test Results' could confirm the fix.

The code changes themselves are approved.

@@ -42,7 +42,7 @@ vLLM is a Python library that supports the following GPU variants. Select your G

=== "NVIDIA CUDA"

--8<-- "docs/getting_started/installation/gpu/cuda.inc.md:create-a-new-python-environment"
--8<-- "docs/getting_started/installation/gpu/cuda.inc.md:set-up-using-python"
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

This change correctly updates the include anchor from create-a-new-python-environment to set-up-using-python. The previous anchor did not exist in docs/getting_started/installation/gpu/cuda.inc.md, which would likely result in a broken or missing content section in the rendered documentation. This fix significantly improves the correctness and usability of the documentation.

Copy link
Member

@DarkLight1337 DarkLight1337 left a comment

Choose a reason for hiding this comment

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

Thanks for fixing!

@DarkLight1337 DarkLight1337 enabled auto-merge (squash) June 18, 2025 05:57
@github-actions github-actions bot added the ready ONLY add when PR is ready to merge/full CI is needed label Jun 18, 2025
@DarkLight1337 DarkLight1337 merged commit cca91a7 into vllm-project:main Jun 18, 2025
57 of 59 checks passed
yeqcharlotte pushed a commit to yeqcharlotte/vllm that referenced this pull request Jun 22, 2025
Signed-off-by: reidliu41 <reid201711@gmail.com>
Co-authored-by: reidliu41 <reid201711@gmail.com>
minpeter pushed a commit to minpeter/vllm that referenced this pull request Jun 24, 2025
Signed-off-by: reidliu41 <reid201711@gmail.com>
Co-authored-by: reidliu41 <reid201711@gmail.com>
Signed-off-by: minpeter <kali2005611@gmail.com>
yangw-dev pushed a commit to yangw-dev/vllm that referenced this pull request Jun 24, 2025
Signed-off-by: reidliu41 <reid201711@gmail.com>
Co-authored-by: reidliu41 <reid201711@gmail.com>
Signed-off-by: Yang Wang <elainewy@meta.com>
gmarinho2 pushed a commit to gmarinho2/vllm that referenced this pull request Jun 26, 2025
Signed-off-by: reidliu41 <reid201711@gmail.com>
Co-authored-by: reidliu41 <reid201711@gmail.com>
xjpang pushed a commit to xjpang/vllm that referenced this pull request Jun 30, 2025
Signed-off-by: reidliu41 <reid201711@gmail.com>
Co-authored-by: reidliu41 <reid201711@gmail.com>
wseaton pushed a commit to wseaton/vllm that referenced this pull request Jun 30, 2025
Signed-off-by: reidliu41 <reid201711@gmail.com>
Co-authored-by: reidliu41 <reid201711@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation ready ONLY add when PR is ready to merge/full CI is needed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants