[Docs] Document name parameter for task.options() (#33061)#63450
Open
dstrodtman wants to merge 1 commit into
Open
[Docs] Document name parameter for task.options() (#33061)#63450dstrodtman wants to merge 1 commit into
dstrodtman wants to merge 1 commit into
Conversation
The `name` keyword for `task.options(name=...).remote()` was accepted but undocumented in `RemoteFunction.options`. Add a Google-style parameter entry to the docstring in `python/ray/remote_function.py`, mirroring the documentation style of adjacent params, so the Ray Core API reference surfaces this option alongside `num_cpus`, `num_gpus`, and friends. Update `ci/lint/pydoclint-baseline.txt` to reflect the additional documented argument. Closes ray-project#33061 [DOC-985] Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> Signed-off-by: Douglas Strodtman <douglas@anyscale.com>
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Code Review
This pull request adds documentation for the name parameter in the RemoteFunction.options docstring and updates the linting baseline file. A review comment suggests adding a type hint to the name parameter description to ensure consistency with the surrounding documentation.
Comment on lines
+206
to
+210
| name: A human-readable name for the task. If set, the name appears | ||
| alongside the task in the Ray Dashboard, logs, and the State API | ||
| (for example, ``ray list tasks``), which is useful for debugging | ||
| and observability. Names don't need to be unique. Defaults to | ||
| the remote function's name. |
Contributor
There was a problem hiding this comment.
To maintain consistency with the immediately adjacent parameters resources and label_selector, please include the type hint (str) for the name parameter. This follows the Google-style docstring convention used for other typed arguments in this method.
Suggested change
| name: A human-readable name for the task. If set, the name appears | |
| alongside the task in the Ray Dashboard, logs, and the State API | |
| (for example, ``ray list tasks``), which is useful for debugging | |
| and observability. Names don't need to be unique. Defaults to | |
| the remote function's name. | |
| name (str): A human-readable name for the task. If set, the name appears | |
| alongside the task in the Ray Dashboard, logs, and the State API | |
| (for example, ``ray list tasks``), which is useful for debugging | |
| and observability. Names don't need to be unique. Defaults to | |
| the remote function's name. |
ray-gardener
Bot
added
docs
edoakes
approved these changes
May 18, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
task.options(name=...).remote()accepts anamekeyword that sets a human-readable display name for the task (visible in the Ray Dashboard, logs, and the State API), but it was missing from theRemoteFunction.optionsdocstring and therefore from the Ray Core API reference. Add a Google-style entry describing the parameter, matching the format of adjacent params likenum_cpus/num_gpus. Also update the pydoclint baseline to reflect the new documented argument.Related issues
Closes #33061
[DOC-985]
Additional information
python/ray/remote_function.py(docstring ofRemoteFunction.options)ci/lint/pydoclint-baseline.txtdoc/source/ray-core/api/core.rstalready autodocsray.remote_function.RemoteFunction.options, so the new parameter description flows through automatically — no separate ref-page edit needed.Generated with Claude Code