-
-
Notifications
You must be signed in to change notification settings - Fork 11.1k
[Doc] ruff format some Python examples #26767
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.
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
Conversation
Signed-off-by: DarkLight1337 <tlleungac@connect.ust.hk>
|
Documentation preview: https://vllm--26767.org.readthedocs.build/en/26767/ |
Signed-off-by: DarkLight1337 <tlleungac@connect.ust.hk>
There was a problem hiding this 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.
|
/gemini review |
There was a problem hiding this 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.
|
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. |
|
I applied it manually after searching for Python code blocks 😅 that's why I only updated up to |
Signed-off-by: DarkLight1337 <tlleungac@connect.ust.hk>
|
Do you plan to make more changes? Or is it safe to start reviewing? |
|
No, I don't plan to update all examples in this PR |
Signed-off-by: DarkLight1337 <tlleungac@connect.ust.hk> Signed-off-by: Dhruvil Bhatt <bhattdbh@amazon.com>
Signed-off-by: DarkLight1337 <tlleungac@connect.ust.hk> Signed-off-by: bbartels <benjamin@bartels.dev>
Signed-off-by: DarkLight1337 <tlleungac@connect.ust.hk>
Signed-off-by: DarkLight1337 <tlleungac@connect.ust.hk>
Signed-off-by: DarkLight1337 <tlleungac@connect.ust.hk> Signed-off-by: xuebwang-amd <xuebwang@amd.com>
Signed-off-by: DarkLight1337 <tlleungac@connect.ust.hk> Signed-off-by: xuebwang-amd <xuebwang@amd.com>
Signed-off-by: DarkLight1337 <tlleungac@connect.ust.hk> Signed-off-by: 0xrushi <6279035+0xrushi@users.noreply.github.com>
Signed-off-by: DarkLight1337 <tlleungac@connect.ust.hk> Signed-off-by: 0xrushi <6279035+0xrushi@users.noreply.github.com>
Purpose
Apply ruff formatting to some Python examples in the docs
Test Plan
Test Result
Essential Elements of an Effective PR Description Checklist
supported_models.mdandexamplesfor a new model.