[Doc] Remove extra whitespace from CI failures doc #20565
Conversation
Signed-off-by: Harry Mellor <[email protected]>
|
👋 Hi! Thank you for contributing to the vLLM project. 💬 Join our developer Slack at https://slack.vllm.ai to discuss your PR in #pr-reviews, coordinate on features in #feat- channels, or join special interest groups in #sig- channels. Just a reminder: PRs would not trigger full CI run by default. Instead, it would only run Once the PR is approved and ready to go, your PR reviewer(s) can run CI to test the changes comprehensively before merging. To run CI, PR reviewers can either: Add 🚀 |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @hmellor, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request is a focused documentation cleanup effort. It systematically addresses and removes unnecessary trailing whitespace from various lines within the ci-failures.md documentation, contributing to a tidier and more professional presentation of the CI failure guidance.
Highlights
- Documentation Cleanup: Removed extraneous trailing whitespace characters from the
docs/contributing/ci-failures.mdfile to enhance readability and maintain consistency.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
This pull request aims to clean up the CI failures documentation by removing extra whitespace. Some of the changes unintentionally alter the document's rendered formatting because trailing whitespace can be significant in Markdown for creating line breaks. The review includes suggestions to restore necessary whitespace to preserve the intended layout and areas where whitespace removal was applied inconsistently.
| - If your failure **is already listed**, it's likely unrelated to your PR. | ||
| Help fixing it is always welcome! | ||
| - Leave comments with links to additional instances of the failure. | ||
| - If your failure **is already listed**, it's likely unrelated to your PR. |
There was a problem hiding this comment.
In Markdown, two trailing spaces are used to create a hard line break. By removing them, the following line Help fixing it is always welcome! will be rendered on the same line as this one, which may not be the intended formatting. Please restore the two trailing spaces to preserve the line break.
| - If your failure **is already listed**, it's likely unrelated to your PR. | |
| - If your failure **is already listed**, it's likely unrelated to your PR. |
| ERROR 05-20 03:26:38 [dump_input.py:68] Dumping input data | ||
| --- Logging error --- | ||
| Traceback (most recent call last): | ||
| File "/usr/local/lib/python3.12/dist-packages/vllm/v1/engine/core.py", line 203, in execute_model | ||
| return self.model_executor.execute_model(scheduler_output) | ||
| return self.model_executor.execute_model(scheduler_output) | ||
| ... | ||
| FAILED failing/test.py:failing_test1 - Failure description | ||
| FAILED failing/test.py:failing_test2 - Failure description | ||
| FAILED failing/test.py:failing_test3 - Failure description | ||
| FAILED failing/test.py:failing_test1 - Failure description | ||
| FAILED failing/test.py:failing_test2 - Failure description | ||
| FAILED failing/test.py:failing_test3 - Failure description | ||
| ``` |
There was a problem hiding this comment.
The change has been applied inconsistently within this code block. Trailing whitespace has been removed from some lines (e.g., 48, 52, 54-56), but not from others (49-51). For consistency, please remove the trailing whitespace from all lines within this code block.
| @@ -78,7 +78,7 @@ tail -525 ci_build.log | wl-copy | |||
|
|
|||
| ## Investigating a CI Test Failure | |||
|
|
|||
| 1. Go to 👉 [Buildkite main branch](https://buildkite.com/vllm/ci/builds?branch=main) | |||
| 1. Go to 👉 [Buildkite main branch](https://buildkite.com/vllm/ci/builds?branch=main) | |||
There was a problem hiding this comment.
The change is inconsistent as lines 82 and 83 in this list still contain trailing whitespace. For consistency, please remove it from those lines as well.
| @@ -97,9 +97,9 @@ CI test failures may be flaky. Use a bash loop to run repeatedly: | |||
|
|
|||
| If you submit a PR to fix a CI failure: | |||
|
|
|||
| - Link the PR to the issue: | |||
| - Link the PR to the issue: | |||
There was a problem hiding this comment.
In Markdown, two trailing spaces create a hard line break. By removing them from lines 100, the descriptions on the following lines will be rendered on the same line as the list item titles. To preserve the intended formatting, please restore the two trailing spaces on both lines.
| - Link the PR to the issue: | |
| - Link the PR to the issue: |
| Add `Closes #12345` to the PR description. | ||
| - Add the `ci-failure` label: | ||
| - Add the `ci-failure` label: |
There was a problem hiding this comment.
In Markdown, two trailing spaces create a hard line break. By removing them from lines 102, the descriptions on the following lines will be rendered on the same line as the list item titles. To preserve the intended formatting, please restore the two trailing spaces on both lines.
| - Add the `ci-failure` label: | |
| - Add the `ci-failure` label: |
Signed-off-by: Harry Mellor <[email protected]>
Signed-off-by: Harry Mellor <[email protected]>
Signed-off-by: Harry Mellor <[email protected]> Signed-off-by: Patrick von Platen <[email protected]>
Signed-off-by: Harry Mellor <[email protected]>
Signed-off-by: Harry Mellor <[email protected]> Signed-off-by: avigny <[email protected]>
Signed-off-by: Harry Mellor <[email protected]>
Essential Elements of an Effective PR Description Checklist
supported_models.mdandexamplesfor a new model.Remove extra whitespace from CI failures doc
Purpose
Test Plan
Test Result
(Optional) Documentation Update