[Tune] Remove pydoclint ignore for Tune docstrings#63500
Open
pseudo-rnd-thoughts wants to merge 2 commits into
Open
[Tune] Remove pydoclint ignore for Tune docstrings#63500pseudo-rnd-thoughts wants to merge 2 commits into
pseudo-rnd-thoughts wants to merge 2 commits into
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 improving the documentation and type hinting across the Ray Tune library. It addresses numerous pydoclint violations by adding missing Args, Returns, and Yields sections to docstrings, and by adding or refining type hints in function signatures. The review feedback correctly identifies several instances where the new docstring descriptions were inaccurate regarding whether parameters were still in use or what their actual types were, specifically pointing out errors in describing variables as dictionaries when they are strings, and marking parameters as unused when they are still active in the implementation.
Signed-off-by: Mark Towers <mark@anyscale.com>
ray-gardener
Bot
added
tune
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
1 participant
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 (which is helpful for agents understanding codebases).
This PR removes all of Tune's ignores then uses Claude to fix all the docstrings / type hints (and reviewed by me to confirm implementations).