Skip to content

[Docs] Fix broken Tune links to overview and intergration - #32442

Merged
richardliaw merged 1 commit into
ray-project:masterfrom
ArturNiederfahrenhorst:fixtunelinks
Feb 10, 2023
Merged

[Docs] Fix broken Tune links to overview and intergration#32442
richardliaw merged 1 commit into
ray-project:masterfrom
ArturNiederfahrenhorst:fixtunelinks

Conversation

@ArturNiederfahrenhorst

Copy link
Copy Markdown
Contributor

Signed-off-by: Artur Niederfahrenhorst artur@anyscale.com

Why are these changes needed?

Screenshot 2023-02-10 at 14 10 39

Screenshot 2023-02-10 at 14 11 27

@justinvyu Heads-up: I believe this was introduced here: 613f4b0

Signed-off-by: Artur Niederfahrenhorst <artur@anyscale.com>

@justinvyu justinvyu left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks!

Comment on lines 150 to +151
"The above snippet was taken from the\n",
"[Tune API documentation](https://github.com/ray-project/ray/blob/master/doc/source/tune/api_docs/integration.rst),\n",
"[Tune API documentation](https://github.com/ray-project/ray/blob/master/doc/source/tune/api/integration.rst),\n",

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This is no longer the case -- we can remove this line. I'll create an issue about adding the new way of adding API references using autosummary.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

What is no longer the case? Feel free to edit this PR if you think there is a superior fix! 🙂

@justinvyu justinvyu Feb 10, 2023

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

The snippet it's mentioning is outdated now and doesn't match the github link anymore. We can just remove this sentence for now.

Nvm. We can update this section fully in a follow-up PR. Let's just fix the broken links for now.

@richardliaw
richardliaw merged commit 2874e47 into ray-project:master Feb 10, 2023
@ArturNiederfahrenhorst

Copy link
Copy Markdown
Contributor Author

Thanks

cadedaniel pushed a commit that referenced this pull request Feb 13, 2023
* [Tune][Doc] Restructure API reference (#32311)

* [Docs] Fix broken Tune links to overview and intergration (#32442)

* Remove can_restore (exists on master but not releases/2.3.0)

Signed-off-by: Justin Yu <justinvyu@berkeley.edu>

---------

Signed-off-by: Justin Yu <justinvyu@berkeley.edu>
Co-authored-by: Artur Niederfahrenhorst <artur@anyscale.com>
edoakes pushed a commit to edoakes/ray that referenced this pull request Mar 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs An issue or change related to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants