[Docs] Refactor Python API documentation for job submission #32252
Conversation
This file contains 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
Signed-off-by: Cheng Su <[email protected]>
c21
requested review from
architkulkarni,
wuisawesome,
DmitriGekhtman,
maxpumperla,
pcmoritz and
a team
as code owners
|
Looks reasonable, looks like the main change is that the main page is less cluttered and you have to click through to read the full dosctrings. Makes sense to make the API docs consistent
|
architkulkarni
approved these changes
Feb 7, 2023
|
@architkulkarni - yes right, that's the main motivation. |
richardliaw
approved these changes
Feb 7, 2023
zhe-thoughts
approved these changes
Feb 7, 2023
c21
added a commit
to c21/ray
that referenced
this pull request
Feb 7, 2023
7 tasks
cadedaniel
pushed a commit
that referenced
this pull request
Feb 8, 2023
edoakes
pushed a commit
to edoakes/ray
that referenced
this pull request
Mar 22, 2023
Signed-off-by: Edward Oakes <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Signed-off-by: Cheng Su [email protected]
Why are these changes needed?
This PR is to refactor Python API documentation for job submission, as same as #31204 .
See https://ray--32252.org.readthedocs.build/en/32252/cluster/running-applications/job-submission/jobs-package-ref.html .
Related issue number
Checks
git commit -s) in this PR.scripts/format.shto lint the changes in this PR.