[AIR] Remove pydoclint ignore for AIR docstrings#63509
[AIR] Remove pydoclint ignore for AIR docstrings#63509pseudo-rnd-thoughts wants to merge 2 commits into
Conversation
Signed-off-by: Mark Towers <mark@anyscale.com>
There was a problem hiding this comment.
Code Review
This pull request addresses numerous docstring violations across the Ray AIR codebase, specifically targeting issues identified by pydoclint. Key changes include adding missing 'Args' and 'Returns' sections, correcting argument names and their order in docstrings to match function signatures, and adding type hints to various function signatures. The reviewer suggested separating the 'Raises' section from the 'Returns' section in the setup_mlflow method to better align with the Google Python Style Guide and improve readability.
| Returns: | ||
| Whether setup is successful. | ||
| None. Raises ``ValueError`` if setup is not successful. |
There was a problem hiding this comment.
It is recommended to use a separate Raises section for exceptions instead of including them in the Returns section. This follows the Google Python Style Guide (which Ray generally follows) and improves readability and consistency with other parts of the codebase, such as RayActorManager.schedule_actor_task.
Returns:
None
Raises:
ValueError: If setup is not successful.Signed-off-by: Mark Towers <mark@anyscale.com>
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 AIR's ignores then uses Claude to fix all the docstrings / type hints (and reviewed by me to confirm implementations).