[Misc] update doc comment for send #22026
Conversation
Signed-off-by: Andy Xie <andy.xning@gmail.com>
|
👋 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.
Code Review
This pull request correctly updates the docstrings for the send methods to indicate that they are blocking operations. My review focuses on improving the docstring format for better clarity and adherence to Python conventions. I've suggested combining the separate string literals into a single, multi-line docstring in all three affected files. This ensures that documentation generation tools will correctly parse the entire comment.
| """Sends a tensor to the destination rank in a blocking way""" | ||
| """NOTE: `dst` is the local rank of the destination rank.""" |
There was a problem hiding this comment.
While the change to 'blocking' is correct, the docstring format is unconventional and can be misleading. According to PEP 257, only the first string literal following a function definition is treated as its docstring. Subsequent string literals are simply statements that are evaluated and then discarded, having no effect.
To ensure the entire comment is recognized as the docstring by documentation tools and help(), it should be a single multi-line string.
| """Sends a tensor to the destination rank in a blocking way""" | |
| """NOTE: `dst` is the local rank of the destination rank.""" | |
| """Sends a tensor to the destination rank in a blocking way. | |
| NOTE: `dst` is the local rank of the destination rank. | |
| """ |
| """Sends a tensor to the destination rank in a blocking way""" | ||
| """NOTE: `dst` is the local rank of the destination rank.""" |
There was a problem hiding this comment.
While the change to 'blocking' is correct, the docstring format is unconventional and can be misleading. According to PEP 257, only the first string literal following a function definition is treated as its docstring. Subsequent string literals are simply statements that are evaluated and then discarded, having no effect.
To ensure the entire comment is recognized as the docstring by documentation tools and help(), it should be a single multi-line string.
| """Sends a tensor to the destination rank in a blocking way""" | |
| """NOTE: `dst` is the local rank of the destination rank.""" | |
| """Sends a tensor to the destination rank in a blocking way. | |
| NOTE: `dst` is the local rank of the destination rank. | |
| """ |
| """Sends a tensor to the destination rank in a blocking way""" | ||
| """NOTE: `dst` is the local rank of the destination rank.""" |
There was a problem hiding this comment.
While the change to 'blocking' is correct, the docstring format is unconventional and can be misleading. According to PEP 257, only the first string literal following a function definition is treated as its docstring. Subsequent string literals are simply statements that are evaluated and then discarded, having no effect.
To ensure the entire comment is recognized as the docstring by documentation tools and help(), it should be a single multi-line string.
| """Sends a tensor to the destination rank in a blocking way""" | |
| """NOTE: `dst` is the local rank of the destination rank.""" | |
| """Sends a tensor to the destination rank in a blocking way. | |
| NOTE: `dst` is the local rank of the destination rank. | |
| """ |
Signed-off-by: Andy Xie <andy.xning@gmail.com>
Signed-off-by: Andy Xie <andy.xning@gmail.com> Signed-off-by: Jinzhen Lin <linjinzhen@hotmail.com>
Signed-off-by: Andy Xie <andy.xning@gmail.com> Signed-off-by: Noam Gat <noamgat@gmail.com>
Signed-off-by: Andy Xie <andy.xning@gmail.com> Signed-off-by: Paul Pak <paulpak58@gmail.com>
Signed-off-by: Andy Xie <andy.xning@gmail.com> Signed-off-by: Diego-Castan <diego.castan@ibm.com>
Signed-off-by: Andy Xie <andy.xning@gmail.com>
Signed-off-by: Andy Xie <andy.xning@gmail.com>
3 participants
Essential Elements of an Effective PR Description Checklist
supported_models.mdandexamplesfor a new model.Purpose
According to the
tensor.distributed.senddoc, send is a synchronous op.Test Plan
NA
Test Result
NA
(Optional) Documentation Update