[Doc] Fix a broken rllib reference #46280
Merged
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: pdmurray <peynmurray@gmail.com>
peytondmurray
requested review from
sven1977,
ArturNiederfahrenhorst,
maxpumperla,
simonsays1980 and
a team
as code owners
8 tasks
can-anyscale
approved these changes
Jun 26, 2024
can-anyscale
pushed a commit
that referenced
this pull request
Jun 27, 2024
## Why are these changes needed? This PR fixes a broken link and type annotation in Ray Train, and re-enables nitpicky mode in the docs. There were two issues affecting the documentation: 1. The autosummary of `ray.data.dataset.Schema` was incorrectly referencing `ray.data.Schema` 2. The docstring of `Schema` contained entries (`types` and `names`) under the `Attribute` section which were already documented using docstrings of their respective properties. The build error that you get when you build the documentation unhelpfully suggested using `noindex`, but instead we just need to either use the docstrings in `Attributes` or the docstrings under the property methods, not both. ## Related issue number Reverts #46241. Blocked by #46280. Signed-off-by: pdmurray <peynmurray@gmail.com> Signed-off-by: Peyton Murray <peynmurray@gmail.com> Co-authored-by: Balaji Veeramani <bveeramani@berkeley.edu>
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 fixes a broken RLlib link.
Related issue number
Currently blocking #46279, but I've broken this change out into a separate PR to minimize codeowner impact.
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.