-
Notifications
You must be signed in to change notification settings - Fork 5.8k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[Doc] Fix broken data docs; reenable nitpicky mode #46279
[Doc] Fix broken data docs; reenable nitpicky mode #46279
Conversation
This reverts commit 70a8152. Signed-off-by: pdmurray <[email protected]>
Signed-off-by: pdmurray <[email protected]>
445ffd2
to
70afe44
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
# 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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What happens if we exclude ".*"
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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 <[email protected]> Signed-off-by: Peyton Murray <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
request change since the name of the api is incorrect (see comments); let me know otherwise
Signed-off-by: pdmurray <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks!
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.Schema
was incorrectly referencingray.data.Schema
Schema
contained entries (types
andnames
) under theAttribute
section 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 inAttributes
or 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.sh
to lint the changes in this PR.method in Tune, I've added it in
doc/source/tune/api/
under thecorresponding
.rst
file.