Skip to content

Conversation

@jjyao
Copy link
Collaborator

@jjyao jjyao commented Oct 31, 2025

Description

Fix typos

Signed-off-by: Jiajun Yao <jeromeyjj@gmail.com>
@jjyao jjyao requested review from a team as code owners October 31, 2025 23:39
@jjyao jjyao added the go add ONLY when ready to merge, run all tests label Oct 31, 2025
Copy link
Collaborator

@edoakes edoakes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

AIJun

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a 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.

Comment on lines 289 to +290
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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

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).

Suggested change
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.

@ray-gardener ray-gardener bot added docs An issue or change related to documentation core Issues that should be addressed in Ray Core labels Nov 1, 2025
@edoakes edoakes merged commit 4b64508 into ray-project:master Nov 1, 2025
5 of 6 checks passed
@jjyao jjyao deleted the jjyao/typoss branch November 1, 2025 20:33
YoussefEssDS pushed a commit to YoussefEssDS/ray that referenced this pull request Nov 8, 2025
Fix typos

Signed-off-by: Jiajun Yao <jeromeyjj@gmail.com>
landscapepainter pushed a commit to landscapepainter/ray that referenced this pull request Nov 17, 2025
Fix typos

Signed-off-by: Jiajun Yao <jeromeyjj@gmail.com>
Aydin-ab pushed a commit to Aydin-ab/ray-aydin that referenced this pull request Nov 19, 2025
Fix typos

Signed-off-by: Jiajun Yao <jeromeyjj@gmail.com>
Signed-off-by: Aydin Abiar <aydin@anyscale.com>
SheldonTsen pushed a commit to SheldonTsen/ray that referenced this pull request Dec 1, 2025
Fix typos

Signed-off-by: Jiajun Yao <jeromeyjj@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

core Issues that should be addressed in Ray Core docs An issue or change related to documentation go add ONLY when ready to merge, run all tests

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants