Skip to content

[Doc] Fix cross-reference warnings #25058

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
Sep 18, 2025
Merged

[Doc] Fix cross-reference warnings #25058

merged 2 commits into from
Sep 18, 2025

Conversation

punitvara
Copy link
Contributor

@punitvara punitvara commented Sep 17, 2025 •
edited by github-actions bot
Loading

Remove or correct broken cross-references in docstrings to resolve mkdocs_autorefs warnings.

related to issue: #25020

@github-actions GitHub Actions
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 ask your reviewers to trigger select CI tests on top of fastcheck CI.

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.

If you have any questions, please reach out to us on Slack at https://slack.vllm.ai.

🚀

@mergify mergify bot added the performance Performance-related issues label Sep 17, 2025
gemini-code-assist[bot]
gemini-code-assist bot reviewed Sep 17, 2025
View reviewed changes
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 addresses a cross-reference warning in the documentation. The change in vllm/benchmarks/datasets.py correctly updates the docstring to use a fully qualified path for LoRARequest, which will resolve the documentation build warning. The change is accurate and improves documentation quality. I have no further suggestions as this is a correct and targeted fix.

@mergify Mergify
Copy link

mergify bot commented Sep 17, 2025

This pull request has merge conflicts that must be resolved before it can be
merged. Please rebase the PR, @punitvara.

https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork

@mergify mergify bot added the needs-rebase label Sep 17, 2025
@punitvara punitvara force-pushed the docs_fixes branch 2 times, most recently from 964fe14 to 412d528 Compare September 17, 2025 09:27
@mergify mergify bot removed the needs-rebase label Sep 17, 2025
@punitvara punitvara force-pushed the docs_fixes branch 2 times, most recently from cd27393 to 8e21e54 Compare September 17, 2025 10:13
@mergify mergify bot added multi-modality Related to multi-modality (#4194) v1 labels Sep 17, 2025
@punitvara punitvara force-pushed the docs_fixes branch 4 times, most recently from accf157 to 285a29f Compare September 17, 2025 15:45
hmellor
hmellor requested changes Sep 17, 2025
View reviewed changes
@mergify Mergify
Copy link

mergify bot commented Sep 17, 2025

This pull request has merge conflicts that must be resolved before it can be
merged. Please rebase the PR, @punitvara.

https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork

@mergify mergify bot added the needs-rebase label Sep 17, 2025
@mergify mergify bot removed the needs-rebase label Sep 17, 2025
hmellor
hmellor requested changes Sep 17, 2025
View reviewed changes
@wwl2755 wwl2755 mentioned this pull request Sep 17, 2025
Merged
@punitvara
[Doc] Fix cross-reference warnings
138dcaf 
- Remove or correct broken cross-references in docstrings to resolve mkdocs_autorefs warnings.
- Wrap bracketed data structure notations in backticks to prevent false cross-references.

related to issue: vllm-project#25020

Signed-off-by: Punit Vara <punitvara@gmail.com>
@punitvara punitvara requested a review from ApostaC as a code owner September 18, 2025 02:34
@punitvara
Copy link
Contributor Author

@hmellor Can you check everything looks good ?

hmellor
hmellor reviewed Sep 18, 2025
View reviewed changes
@hmellor
Update vllm/model_executor/layers/mamba/ops/causal_conv1d.py
ef094dd 
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
hmellor
hmellor approved these changes Sep 18, 2025
View reviewed changes
Copy link
Member

@hmellor hmellor left a comment

Choose a reason for hiding this comment

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

LGTM, thanks for taking the time to learn vLLM's contribution process!

@vllm-bot vllm-bot merged commit 05b044e into vllm-project:main Sep 18, 2025
7 of 13 checks passed
debroy-rh pushed a commit to debroy-rh/vllm that referenced this pull request Sep 19, 2025
@punitvara @hmellor @debroy-rh
[Doc] Fix cross-reference warnings (vllm-project#25058)
b082eb4 
Signed-off-by: Punit Vara <punitvara@gmail.com>
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
Co-authored-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
FeiDaLI pushed a commit to FeiDaLI/vllm that referenced this pull request Sep 25, 2025
@punitvara @hmellor @FeiDaLI
[Doc] Fix cross-reference warnings (vllm-project#25058)
b95d47a 
Signed-off-by: Punit Vara <punitvara@gmail.com>
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
Co-authored-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
charlifu pushed a commit to ROCm/vllm that referenced this pull request Sep 25, 2025
@punitvara @hmellor @charlifu
[Doc] Fix cross-reference warnings (vllm-project#25058)
6a7d69c 
Signed-off-by: Punit Vara <punitvara@gmail.com>
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
Co-authored-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
Signed-off-by: charlifu <charlifu@amd.com>
xuebwang-amd pushed a commit to xuebwang-amd/vllm that referenced this pull request Oct 10, 2025
@punitvara @hmellor @xuebwang-amd
[Doc] Fix cross-reference warnings (vllm-project#25058)
5980b54 
Signed-off-by: Punit Vara <punitvara@gmail.com>
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
Co-authored-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
Signed-off-by: xuebwang-amd <xuebwang@amd.com>
choprahetarth pushed a commit to Tandemn-Labs/vllm that referenced this pull request Oct 11, 2025
@punitvara @hmellor @choprahetarth
[Doc] Fix cross-reference warnings (vllm-project#25058)
0e20d04 
Signed-off-by: Punit Vara <punitvara@gmail.com>
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
Co-authored-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
sducouedic pushed a commit to sducouedic/vllm that referenced this pull request Oct 16, 2025
@punitvara @hmellor
[Doc] Fix cross-reference warnings (vllm-project#25058)
a78c020 
Signed-off-by: Punit Vara <punitvara@gmail.com>
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
Co-authored-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@hmellor hmellor hmellor approved these changes

@patrickvonplaten patrickvonplaten Awaiting requested review from patrickvonplaten patrickvonplaten is a code owner

@WoosukKwon WoosukKwon Awaiting requested review from WoosukKwon WoosukKwon is a code owner

@robertgshaw2-redhat robertgshaw2-redhat Awaiting requested review from robertgshaw2-redhat robertgshaw2-redhat is a code owner

@njhill njhill Awaiting requested review from njhill njhill is a code owner

@ywang96 ywang96 Awaiting requested review from ywang96 ywang96 is a code owner

@comaniac comaniac Awaiting requested review from comaniac comaniac is a code owner

@alexm-redhat alexm-redhat Awaiting requested review from alexm-redhat alexm-redhat is a code owner

@heheda12345 heheda12345 Awaiting requested review from heheda12345 heheda12345 is a code owner

@DarkLight1337 DarkLight1337 Awaiting requested review from DarkLight1337 DarkLight1337 is a code owner

@NickLucche NickLucche Awaiting requested review from NickLucche NickLucche is a code owner

@tdoublep tdoublep Awaiting requested review from tdoublep tdoublep is a code owner

@ApostaC ApostaC Awaiting requested review from ApostaC ApostaC is a code owner

+1 more reviewer

@gemini-code-assist gemini-code-assist[bot] gemini-code-assist[bot] left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

multi-modality Related to multi-modality (#4194) performance Performance-related issues v1

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@punitvara @hmellor @vllm-bot