[Serve] Expose ProxyStatus class to API docs (#43394)#48299
Merged
zcin merged 8 commits intoray-project:masterfrom Oct 30, 2024
Merged
[Serve] Expose ProxyStatus class to API docs (#43394)#48299zcin merged 8 commits intoray-project:masterfrom
zcin merged 8 commits intoray-project:masterfrom
Conversation
Signed-off-by: akyang-anyscale <alexyang@anyscale.com>
Signed-off-by: akyang-anyscale <alexyang@anyscale.com>
Signed-off-by: akyang-anyscale <alexyang@anyscale.com>
Signed-off-by: akyang-anyscale <alexyang@anyscale.com>
Signed-off-by: akyang-anyscale <alexyang@anyscale.com>
edoakes
approved these changes
Oct 29, 2024
Contributor
Author
I think it could be unrelated to the changes in this PR. The error is in |
Contributor
|
Oh I think somehow I introduced this ... not sure how but probably outdated master on one of my PRs |
Contributor
Signed-off-by: akyang-anyscale <alexyang@anyscale.com>
Signed-off-by: akyang-anyscale <alexyang@anyscale.com>
JP-sDEV
pushed a commit
to JP-sDEV/ray
that referenced
this pull request
Nov 14, 2024
…-project#48299) ## Why are these changes needed? <!-- Please give a short summary of the change and the problem this solves. --> This PR moves `ProxyStatus` out of the `_private` directory, allowing it to be included in the API docs. This is the final attribute of `ServeStatus` that needs to be included in the documentation. ## Related issue number <!-- For example: "Closes ray-project#1234" --> Closes ray-project#43394 --------- Signed-off-by: akyang-anyscale <alexyang@anyscale.com>
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
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.
Why are these changes needed?
This PR moves
ProxyStatusout of the_privatedirectory, allowing it to be included in the API docs. This is the final attribute ofServeStatusthat needs to be included in the documentation.Related issue number
Closes #43394
Checks
git commit -s) in this PR.scripts/format.shto lint the changes in this PR.method in Tune, I've added it in
doc/source/tune/api/under thecorresponding
.rstfile.