[CI/Build] fix doc build warning: Failed to get 'name: description' pair #25733
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Code Review
This pull request aims to fix a documentation build warning by adjusting the indentation in a docstring. While the change silences the warning, it doesn't address the root cause, which is an incorrect nesting of a parameter in the docstring. My review provides a code suggestion to fix the docstring's structure, making it both correct and more readable. This also ensures that documentation generation tools will parse it correctly in the future.
yitingdc
force-pushed
the
doc-warning
branch
from
1948ac4 to
fde2b31
Compare
Signed-off-by: yiting.jiang <[email protected]>
yitingdc
force-pushed
the
doc-warning
branch
from
fde2b31 to
3e51ea1
Compare
chaunceyjiang
added
the
ready
chaunceyjiang
changed the title
Collaborator
|
buildkite/ci/pr/v1-test-others — track #25745 |
pdasigi
pushed a commit
to pdasigi/vllm
that referenced
this pull request
Oct 2, 2025
…air (vllm-project#25733) Signed-off-by: yiting.jiang <[email protected]>
yewentao256
pushed a commit
that referenced
this pull request
Oct 3, 2025
…air (#25733) Signed-off-by: yiting.jiang <[email protected]> Signed-off-by: yewentao256 <[email protected]>
xuebwang-amd
pushed a commit
to xuebwang-amd/vllm
that referenced
this pull request
Oct 10, 2025
…air (vllm-project#25733) Signed-off-by: yiting.jiang <[email protected]> Signed-off-by: xuebwang-amd <[email protected]>
choprahetarth
pushed a commit
to Tandemn-Labs/vllm
that referenced
this pull request
Oct 11, 2025
…air (vllm-project#25733) Signed-off-by: yiting.jiang <[email protected]>
lywa1998
pushed a commit
to lywa1998/vllm
that referenced
this pull request
Oct 20, 2025
…air (vllm-project#25733) Signed-off-by: yiting.jiang <[email protected]>
alhridoy
pushed a commit
to alhridoy/vllm
that referenced
this pull request
Oct 24, 2025
…air (vllm-project#25733) Signed-off-by: yiting.jiang <[email protected]>
xuebwang-amd
pushed a commit
to xuebwang-amd/vllm
that referenced
this pull request
Oct 24, 2025
…air (vllm-project#25733) Signed-off-by: yiting.jiang <[email protected]> Signed-off-by: xuebwang-amd <[email protected]>
rtourgeman
pushed a commit
to rtourgeman/vllm
that referenced
this pull request
Nov 10, 2025
…air (vllm-project#25733) Signed-off-by: yiting.jiang <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Follow up #24986
Fix doc build waring:
Purpose
if this warning exists, other pr cannot doc validation cannot passed
https://app.readthedocs.org/projects/vllm/builds/29726695/
Test Plan
Test Result
Essential Elements of an Effective PR Description Checklist
supported_models.mdandexamplesfor a new model.