Skip to content

[Doc] Fix format of multimodal_inputs.md#31800

Merged
DarkLight1337 merged 1 commit intovllm-project:mainfrom
BlankRH:fix-multimodal-doc
Jan 6, 2026
Merged

[Doc] Fix format of multimodal_inputs.md#31800
DarkLight1337 merged 1 commit intovllm-project:mainfrom
BlankRH:fix-multimodal-doc

Conversation

@BlankRH
Copy link
Copy Markdown
Contributor

@BlankRH BlankRH commented Jan 6, 2026

Purpose

Fix format for python code block in doc.


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.
  • (Optional) Release notes update. If your change is user facing, please update the release notes draft in the Google Doc.

@mergify
Copy link
Copy Markdown

mergify bot commented Jan 6, 2026

Documentation preview: https://vllm--31800.org.readthedocs.build/en/31800/

@mergify
Copy link
Copy Markdown

mergify bot commented Jan 6, 2026

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

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

@mergify mergify bot added documentation Improvements or additions to documentation needs-rebase labels Jan 6, 2026
@BlankRH BlankRH changed the title Fix markdown format of multimodal_inputs.md [Doc] Fix markdown format of multimodal_inputs.md Jan 6, 2026
@mergify mergify bot removed the needs-rebase label Jan 6, 2026
Copy link
Copy Markdown
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.

If you take a look at the doc page, you can see that the content is properly formatted. Those blocks are parsed by MkDocs which extends Markdown syntax.

Copy link
Copy Markdown
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 updates the markdown formatting in multimodal_inputs.md to improve syntax highlighting in code blocks. The changes involve replacing mkdocs-material specific admonition syntax (!!! note, ??? code, etc.) with standard markdown blockquotes and fenced code blocks. While most of the changes are correct and achieve the intended goal, I've found a few instances where the conversion to blockquotes has introduced incorrect indentation. This can lead to improper rendering of lists and code blocks. I've provided specific suggestions to fix these formatting issues.

Signed-off-by: BlankR <hjyblanche@gmail.com>
@BlankRH BlankRH force-pushed the fix-multimodal-doc branch from 9eab3ec to 941b71a Compare January 6, 2026 10:15
@BlankRH
Copy link
Copy Markdown
Contributor Author

BlankRH commented Jan 6, 2026

If you take a look at the doc page, you can see that the content is properly formatted. Those blocks are parsed by MkDocs which extends Markdown syntax.

Ah I see. Thanks for pointing this out! I have updated the PR to only include the proper fix.

@BlankRH BlankRH changed the title [Doc] Fix markdown format of multimodal_inputs.md [Doc] Fix format of multimodal_inputs.md Jan 6, 2026
@DarkLight1337 DarkLight1337 enabled auto-merge (squash) January 6, 2026 10:17
@DarkLight1337 DarkLight1337 added the ready ONLY add when PR is ready to merge/full CI is needed label Jan 6, 2026
@DarkLight1337 DarkLight1337 merged commit 6ebb66c into vllm-project:main Jan 6, 2026
11 of 12 checks passed
LucasWilkinson pushed a commit to neuralmagic/vllm that referenced this pull request Jan 6, 2026
Signed-off-by: BlankR <hjyblanche@gmail.com>
yugong333 pushed a commit to yugong333/vllm that referenced this pull request Jan 9, 2026
Signed-off-by: BlankR <hjyblanche@gmail.com>
akh64bit pushed a commit to akh64bit/vllm that referenced this pull request Jan 16, 2026
Signed-off-by: BlankR <hjyblanche@gmail.com>
dsuhinin pushed a commit to dsuhinin/vllm that referenced this pull request Jan 21, 2026
Signed-off-by: BlankR <hjyblanche@gmail.com>
Signed-off-by: dsuhinin <suhinin.dmitriy@gmail.com>
ItzDEXX pushed a commit to ItzDEXX/vllm that referenced this pull request Feb 19, 2026
Signed-off-by: BlankR <hjyblanche@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