Skip to content

[Core] Remove ray core docstring ignores from pydoclint#63639

Open
pseudo-rnd-thoughts wants to merge 10 commits into
ray-project:masterfrom
pseudo-rnd-thoughts:fix-pydoclint-core
Open

[Core] Remove ray core docstring ignores from pydoclint#63639
pseudo-rnd-thoughts wants to merge 10 commits into
ray-project:masterfrom
pseudo-rnd-thoughts:fix-pydoclint-core

Conversation

@pseudo-rnd-thoughts
Copy link
Copy Markdown
Member

#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).

Mark Towers added 2 commits May 25, 2026 17:07
Signed-off-by: Mark Towers <mark@anyscale.com>
Signed-off-by: Mark Towers <mark@anyscale.com>
@pseudo-rnd-thoughts pseudo-rnd-thoughts requested a review from a team as a code owner May 26, 2026 12:03
@pseudo-rnd-thoughts pseudo-rnd-thoughts added the core Issues that should be addressed in Ray Core label May 26, 2026
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

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

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.

Comment thread python/ray/tests/ludwig/ludwig_test_utils.py
Mark Towers added 2 commits June 3, 2026 09:29
Signed-off-by: Mark Towers <mark@anyscale.com>
@pseudo-rnd-thoughts pseudo-rnd-thoughts added the go add ONLY when ready to merge, run all tests label Jun 3, 2026
Mark Towers 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>
@edoakes edoakes enabled auto-merge (squash) June 8, 2026 16:36
Signed-off-by: Mark Towers <mark@anyscale.com>
@github-actions github-actions Bot disabled auto-merge June 8, 2026 16:53
@edoakes edoakes enabled auto-merge (squash) June 8, 2026 17:40
@github-actions github-actions Bot disabled auto-merge June 8, 2026 19:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

core Issues that should be addressed in Ray Core go add ONLY when ready to merge, run all tests

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants