Skip to content

Conversation

@DarkLight1337
Copy link
Member

@DarkLight1337 DarkLight1337 commented Oct 14, 2025

Purpose

Apply ruff formatting to some Python examples in the docs

Test Plan

Test Result


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.

Signed-off-by: DarkLight1337 <tlleungac@connect.ust.hk>
@DarkLight1337 DarkLight1337 requested a review from hmellor October 14, 2025 06:31
@mergify
Copy link

mergify bot commented Oct 14, 2025

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

@mergify mergify bot added documentation Improvements or additions to documentation tool-calling labels Oct 14, 2025
Signed-off-by: DarkLight1337 <tlleungac@connect.ust.hk>
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 applies ruff formatting to Python code examples across various documentation files, improving code style consistency. The changes are mostly correct and enhance readability. However, I found a critical issue in one of the code examples which contains a syntax error that was present before and was not fixed by the formatting changes. It's important for documentation examples to be syntactically correct.

Signed-off-by: DarkLight1337 <tlleungac@connect.ust.hk>
@DarkLight1337
Copy link
Member Author

/gemini review

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 applies ruff formatting to Python examples in the documentation, which improves code consistency and readability. I've also noted a couple of instances where this formatting pass corrected syntax errors in the code examples, which is a great improvement for the documentation's quality. The changes look good, and I have no further suggestions.

@hmellor
Copy link
Member

hmellor commented Oct 14, 2025

How were you applying the formatting?

We could use https://github.com/adamchainz/blacken-docs to keep the docs formatted this way? Ruff uses the Black ruleset so the formatted code would look the same.

@DarkLight1337
Copy link
Member Author

DarkLight1337 commented Oct 14, 2025

I applied it manually after searching for Python code blocks 😅 that's why I only updated up to features directory

Signed-off-by: DarkLight1337 <tlleungac@connect.ust.hk>
@hmellor
Copy link
Member

hmellor commented Oct 14, 2025

Do you plan to make more changes? Or is it safe to start reviewing?

@DarkLight1337
Copy link
Member Author

No, I don't plan to update all examples in this PR

@vllm-bot vllm-bot merged commit ef9676a into vllm-project:main Oct 14, 2025
5 checks passed
Dhruvilbhatt pushed a commit to Dhruvilbhatt/vllm that referenced this pull request Oct 14, 2025
Signed-off-by: DarkLight1337 <tlleungac@connect.ust.hk>
Signed-off-by: Dhruvil Bhatt <bhattdbh@amazon.com>
bbartels pushed a commit to bbartels/vllm that referenced this pull request Oct 16, 2025
Signed-off-by: DarkLight1337 <tlleungac@connect.ust.hk>
Signed-off-by: bbartels <benjamin@bartels.dev>
lywa1998 pushed a commit to lywa1998/vllm that referenced this pull request Oct 20, 2025
Signed-off-by: DarkLight1337 <tlleungac@connect.ust.hk>
alhridoy pushed a commit to alhridoy/vllm that referenced this pull request Oct 24, 2025
Signed-off-by: DarkLight1337 <tlleungac@connect.ust.hk>
xuebwang-amd pushed a commit to xuebwang-amd/vllm that referenced this pull request Oct 24, 2025
Signed-off-by: DarkLight1337 <tlleungac@connect.ust.hk>
Signed-off-by: xuebwang-amd <xuebwang@amd.com>
xuebwang-amd pushed a commit to xuebwang-amd/vllm that referenced this pull request Oct 24, 2025
Signed-off-by: DarkLight1337 <tlleungac@connect.ust.hk>
Signed-off-by: xuebwang-amd <xuebwang@amd.com>
0xrushi pushed a commit to 0xrushi/vllm that referenced this pull request Oct 26, 2025
Signed-off-by: DarkLight1337 <tlleungac@connect.ust.hk>
Signed-off-by: 0xrushi <6279035+0xrushi@users.noreply.github.com>
0xrushi pushed a commit to 0xrushi/vllm that referenced this pull request Oct 26, 2025
Signed-off-by: DarkLight1337 <tlleungac@connect.ust.hk>
Signed-off-by: 0xrushi <6279035+0xrushi@users.noreply.github.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 tool-calling

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

3 participants