Skip to content

docs: fix Python client RayJob submission example - #5368

Open
git-jxj wants to merge 2 commits into
kuberay-project:masterfrom
git-jxj:docs/fix-python-rayjob-submission-example-20261002
Open

git-jxj wants to merge 2 commits into
kuberay-project:masterfrom
git-jxj:docs/fix-python-rayjob-submission-example-20261002

Conversation

@git-jxj

@git-jxj git-jxj commented Oct 2, 2026 •

Copy link
Copy Markdown

Why are these changes needed?

The Python client README calls submit_job on the kuberay_job_api module, which raises AttributeError; the method belongs to RayjobApi. The example also contains an unserializable metadata placeholder, an undefined namespace, and a python -c command that tries to evaluate a filename.

Instantiate RayjobApi and provide a concrete job name, namespace, and executable entrypoint. Explain how to select an existing cluster in another namespace. Keep the example compatible with the renamed kuberay_client package.

Related issue number

N/A — correction to the existing RayJob submission example.

Labels

  • If this PR has user-facing changes that require documentation updates at release time, I have added the doc-updates-required label.
  • If this PR contains breaking changes, I have added the breaking-change label.

AI assistance

Yes. AI assisted with the documentation changes and testing.

Checks

  • I've made sure the tests are passing.
  • Testing Strategy
    • Unit tests
    • Manual tests

Manual test instructions

Executed the README snippet through the real Python client with Kubernetes server-side dry-run and validated the job body against the current RayJob CRD schema. Executed the example entrypoint locally (output: 2). Ran markdownlint 0.44.0 with the repository configuration and the applicable whitespace/file pre-commit checks. This does not run a RayJob or a Ray cluster.

@win5923 win5923 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Thanks!

@win5923 win5923 added the lgtm Ready for final review / merge label Oct 5, 2026
git-jxj and others added 2 commits October 28, 2026 14:32
Signed-off-by: xinjun.jiang <xinjun.jiang@daocloud.io>
Signed-off-by: xinjun.jiang <xinjun.jiang@daocloud.io>
@git-jxj
git-jxj force-pushed the docs/fix-python-rayjob-submission-example-20261002 branch from b673964 to beffcd7 Compare October 28, 2026 06:34

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

lgtm Ready for final review / merge

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants