[Train] Fix all of Train's pydoclint issues#63365
Merged
matthewdeng merged 3 commits intoMay 18, 2026
Merged
Conversation
Signed-off-by: Mark Towers <mark@anyscale.com>
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Code Review
This pull request focuses on resolving a large number of pydoclint violations across the ray.train module by standardizing docstrings and type hints. Key improvements include adding missing Args, Returns, and Yields sections, reordering docstring parameters to match function signatures, and refining type annotations for clarity. A review comment correctly identifies a discrepancy in BackendExecutor._create_rank_world_size_mappings, where the docstring describes the return value as a tuple while the implementation and type hint specify a list.
added 2 commits
May 15, 2026 12:38
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
2 participants
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.
Description
#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.
This PR removes all of Train's ignores then uses Claude to fix all the docstrings / type hints (and reviewed by me to confirm implementations).