-
Notifications
You must be signed in to change notification settings - Fork 7k
Fix typos #58349
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
Fix typos #58349
Conversation
edoakes
left a comment
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.
AIJun
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 fixes several typos across the codebase. The changes are correct and improve code quality. I've added one comment regarding an incorrect function signature and docstring in python/ray/dashboard/modules/reporter/profile_manager.py that should be addressed.
| Tuple[bool, str]: A tuple containing a boolean indicating the success | ||
| of the operation and a string of a sucess message or an error message. | ||
| of the operation and a string of a success message or an error message. |
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.
The type hint in the docstring for attach_profiler is Tuple[bool, str], but the implementation returns a 3-element tuple: (bool, Optional[str], str). This is misleading and can cause issues for developers using this function.
The docstring and the function's type hint should be updated to reflect the actual return type. Please also update the function signature on line 274 from -> (bool, str) to -> Tuple[bool, Optional[str], str] and add the necessary imports from typing (Tuple, Optional).
| Tuple[bool, str]: A tuple containing a boolean indicating the success | |
| of the operation and a string of a sucess message or an error message. | |
| of the operation and a string of a success message or an error message. | |
| Tuple[bool, Optional[str], str]: A tuple containing a boolean indicating the | |
| success of the operation, the profiler filename if successful, and a string with a success or an error message. |
Fix typos Signed-off-by: Jiajun Yao <jeromeyjj@gmail.com>
Fix typos Signed-off-by: Jiajun Yao <jeromeyjj@gmail.com>
Fix typos Signed-off-by: Jiajun Yao <jeromeyjj@gmail.com> Signed-off-by: Aydin Abiar <aydin@anyscale.com>
Fix typos Signed-off-by: Jiajun Yao <jeromeyjj@gmail.com>
Description
Fix typos