[Docs] Fix broken autorefs cross-reference in TurboQuant v2 docstring - #51857
Merged
vllm-bot merged 2 commits intoAug 11, 2026
Merged
Conversation
The module docstring wrote `pair_table[i][j]` unquoted, which Markdown parses as a reference link and mkdocs-autorefs then fails to resolve, emitting the only WARNING in the docs build. Wrap the expression in backticks so it renders as code. Co-authored-by: Claude Opus 5 <noreply@anthropic.com> Signed-off-by: Harry Mellor <hej.mellor@gmail.com> Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com>
hmellor
requested review from
LucasWilkinson and
MatthewBonanni
as code owners
August 11, 2026 18:13
AndreasKaratzas
approved these changes
Aug 11, 2026
Member
|
/ci run |
|
✅ Triggered Buildkite CI #83408 for commit |
Member
|
/ci run |
|
✅ Triggered Buildkite CI #83414 for commit |
mgoin
approved these changes
Aug 11, 2026
zyp2014
pushed a commit
to zyp2014/vllm
that referenced
this pull request
Aug 21, 2026
…vllm-project#51857) Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com> Co-authored-by: Andreas Karatzas <akaratza@amd.com>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Purpose
The docs build emits exactly one
WARNING, from thetriton_turboquant_decode_v2module docstring:The docstring writes
pair_table[i][j]unquoted. Markdown parses[i][j]as a full reference link (texti, referencej),mkdocs-autorefsthen tries to resolvejas a cross-reference target and fails. Wrapping the expression in backticks makes it render as code, which is also how the same construct is already written elsewhere in the codebase (e.g.`blocks[i][j]`invllm/v1/core/kv_cache_manager.py).Docstring text only, no functional change.
Not a duplicate
Checked with:
No open PR touches this docstring or the autorefs warning.
Test Plan
Full
mkdocs buildbefore and after the change, with all output captured (not just the tail).Test Result
Before (on
upstream/main@52be12cfac):After:
pre-commit run --files vllm/v1/attention/ops/turboquant_soa/triton_turboquant_decode_v2.pypasses.No model evaluation is included because the change is confined to a module docstring and cannot affect output, accuracy, or serving.
Note
AI assistance (Claude Code) was used for this change. I have reviewed every changed line and run the commands above myself.