[Core] Remove ray core docstring ignores from pydoclint#63639
Open
pseudo-rnd-thoughts wants to merge 10 commits into
Open
[Core] Remove ray core docstring ignores from pydoclint#63639pseudo-rnd-thoughts wants to merge 10 commits into
pseudo-rnd-thoughts wants to merge 10 commits into
Conversation
added 2 commits
May 25, 2026 17:07
Signed-off-by: Mark Towers <mark@anyscale.com>
Signed-off-by: Mark Towers <mark@anyscale.com>
Contributor
There was a problem hiding this comment.
Code Review
This pull request resolves numerous pydoclint baseline violations across the Ray codebase by adding missing type hints, updating docstrings to match function signatures, and documenting previously undocumented parameters. A critical issue was identified in python/ray/tests/ludwig/ludwig_test_utils.py where LocalBackend is used directly as a type hint. Since ludwig is an optional dependency, this will cause a NameError at runtime when ludwig is not installed, so it should be enclosed in quotes as a string literal.
edoakes
approved these changes
Jun 2, 2026
added 2 commits
June 3, 2026 09:29
Signed-off-by: Mark Towers <mark@anyscale.com>
added 3 commits
June 3, 2026 10:36
Signed-off-by: Mark Towers <mark@anyscale.com>
# Conflicts: # ci/lint/pydoclint-baseline.txt
Signed-off-by: Mark Towers <mark@anyscale.com>
Signed-off-by: Mark Towers <mark@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.
#52974 added pydoclint to pre-commit without fixing any issues through adding all the problematic docstrings to an ignore list.
However this means that all the docstrings that do have issues / problems with them that aren't raised or fixed (which is helpful for agents understanding codebases).
This PR removes all of the ray core ignores then uses Claude to fix all the docstrings / type hints (and reviewed by me to confirm implementations).