[freyfwt]

Overview

Format tensor shapes and array indexing as inline code in three MiniMax-M3 AMD docstrings, fixing the seven unresolved cross-references that abort strict API documentation builds.

Fixes #64469. The failing Read the Docs build contains the original warnings.

Claims

• Render the shapes and indexing literally, avoiding unintended head, :n, and r cross-references.
• Keep the change to three docstrings; the AST is identical after removing docstrings.

Validation

Python 3.12.13 with the repository-pinned requirements/docs.txt:

READTHEDOCS_CANONICAL_URL=https://docs.vllm.ai/en/latest/ \
  .venv/bin/python -m mkdocs build --clean \
  --site-dir /tmp/vllm-docs --config-file mkdocs.yaml --strict

• Base fa3b9d1377219247060d3c8b49eae199c9e7e154: exit 1, reproducing all seven warnings (head ×2, :n ×4, r ×1); output: Aborted with 7 warnings in strict mode!.
• Patched tree, same command and dependencies: exit 0, zero MkDocs/autorefs warnings; output: Documentation built in 112.08 seconds.
• Generated HTML: all four affected shape/indexing expressions are rendered as <code> spans across the three API pages.

All applicable pre-commit hooks passed on the three changed files, including Ruff and mypy (Python 3.11 target). Hooks with no matching changed files were excluded from environment setup. git diff --check and a docstring-stripped AST comparison passed.

Hosted API documentation validation requires the build-docs label because this PR changes only vllm/; that label needs to be applied by a maintainer.

Hosted CI is currently blocked by the pre-run-check contributor gate: it found one merged PR for the author, below the required four, and no accepted verified/ready/ready-run-all-tests label. Hosted pre-commit and formatting checks were skipped. Read the Docs build 35491934 was also skipped, so its success status is not a documentation build result. The local before/after strict-build evidence above is the completed validation.

Details

Use the inline-code style already present in these docstrings. Searches for #64469 and related MiniMax docstring fixes found no existing implementation. AI assistance was used for implementation, validation, and this description.

---

Pull Request Checklist

• I used vLLM's /pr-checklist skill. (Mandatory for agents, optional for humans).
• AI assistance was used during the creation of this PR.
• Design Fit: Minimizes impact on core components, reuses existing functionality, and justifies added complexity.
• Testing and Validation: Validates the change and ensures any added tests are meaningful and reliable, with CI coverage or documented CI resource constraints and validation performed outside CI.
• Code Quality and Style: Keeps code and comments clear and concise, and updates relevant documentation and examples.
• Pull Request Contents: Includes a brief summary and relevant links, supports claims with evidence, explains root causes and implementation trade-offs, and follows the contributing guide.

[claude]

Claude Code Review

This pull request is from a fork — automated review is disabled. A repository maintainer can comment @claude review to run a one-time review.

[hmellor]

/ci run

[github-actions]

✅ Triggered Buildkite CI #98268 for commit c491f7eb3a98.

ℹ️ This PR is 6 commits behind upstream main. Merged upstream main into this branch as c491f7eb3a98 before starting CI. Pull the branch before pushing more changes.