-
-
Notifications
You must be signed in to change notification settings - Fork 10.5k
[Docs] vllm/benchmarks/datasets.py fix docstring param format. #24970
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
[Docs] vllm/benchmarks/datasets.py fix docstring param format. #24970
Conversation
👋 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 You ask your reviewers to trigger select CI tests on top of 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 If you have any questions, please reach out to us on Slack at https://slack.vllm.ai. 🚀 |
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 addresses docstring formatting issues in vllm/benchmarks/datasets.py
to ensure compatibility with documentation generation tools like griffe
. The changes are well-executed and correctly fix indentation, parameter descriptions, and cross-referencing syntax within the docstrings. These modifications improve the overall quality and readability of the code documentation. The pull request successfully meets its objective, and I found no high or critical issues in the changes.
1785adf
to
9068d1b
Compare
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.
LGTM, thanks!
Related to issue #25020 |
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.
Thanks for the PR, please use Mkdocs format for the cross references (you've used Sphinx), see https://mkdocstrings.github.io/usage/#cross-references
This pull request has merge conflicts that must be resolved before it can be |
Signed-off-by: samzong <samzong.lu@gmail.com>
9068d1b
to
f6d480c
Compare
…project#24970) Signed-off-by: samzong <samzong.lu@gmail.com>
…project#24970) Signed-off-by: samzong <samzong.lu@gmail.com> Signed-off-by: charlifu <charlifu@amd.com>
Purpose
Ensure BenchmarkDataset docstrings follow the name (type): description format so griffe stops emitting parsing warnings.
Test Plan
Test Result
Essential Elements of an Effective PR Description Checklist
supported_models.md
andexamples
for a new model.