[Doc] Fix broken data docs; reenable nitpicky mode #46279
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
This reverts commit 70a8152. Signed-off-by: pdmurray <peynmurray@gmail.com>
Signed-off-by: pdmurray <peynmurray@gmail.com>
peytondmurray
force-pushed
the
fix-broken-data-docs
branch
from
445ffd2
to
70afe44
Compare
peytondmurray
requested review from
ericl,
scv119,
c21,
amogkam,
scottjlee,
bveeramani,
raulchen,
stephanie-wang,
omatthew98 and
a team
as code owners
8 tasks
Signed-off-by: pdmurray <peynmurray@gmail.com>
can-anyscale
approved these changes
Jun 26, 2024
bveeramani
reviewed
Jun 27, 2024
| # arising from type annotations. See https://github.com/ray-project/ray/pull/46103 | ||
| # for additional context. | ||
| nitpicky = True | ||
| nitpick_ignore_regex = [("py:class", ".*")] |
There was a problem hiding this comment.
What happens if we exclude ".*"?
There was a problem hiding this comment.
We get a bunch of false error messages from trouble that Sphinx has with type generics, which are used as annotations in various places in the code base. There's definitely other ways to deal with this issue, but this is the most straightforward right now.
In the future it might be worth investigating ways to remove this rule, because we'll be better protected against invalid class references, but for now I think this is a good start.
Co-authored-by: Balaji Veeramani <bveeramani@berkeley.edu> Signed-off-by: Peyton Murray <peynmurray@gmail.com>
Signed-off-by: pdmurray <peynmurray@gmail.com>
can-anyscale
requested changes
Jun 27, 2024
Signed-off-by: pdmurray <peynmurray@gmail.com>
can-anyscale
approved these changes
Jun 27, 2024
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 link and type annotation in Ray Train, and re-enables nitpicky mode in the docs.
There were two issues affecting the documentation:
ray.data.dataset.Schemawas incorrectly referencingray.data.SchemaSchemacontained entries (typesandnames) under theAttributesection which were already documented using docstrings of their respective properties. The build error that you get when you build the documentation unhelpfully suggested usingnoindex, but instead we just need to either use the docstrings inAttributesor the docstrings under the property methods, not both.Related issue number
Reverts #46241. Blocked by #46280.
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.