[Core] Remove ray._private docstring ignores from pydoclint#63541
Conversation
Signed-off-by: Mark Towers <mark@anyscale.com>
pseudo-rnd-thoughts
requested review from
a team,
MengjinYan,
dayshah and
edoakes
as code owners
| If you have a custom server to serve the dashboard requests, | ||
| you can set this option to override the server url. | ||
| Ex: proxy_server_url=http://historyserver:8080 | ||
| **kwargs: Hidden / experimental options. Recognized keys include |
There was a problem hiding this comment.
I dislike that we have to do this though is necessary for PyDocLint.
If we dislike these changes, I'm happy to add back to the ignore list but just wanted this PR to include all the possible changes
| See :ref:`more info here <ray-pass-large-arg-by-value>`. | ||
|
|
||
| Args: | ||
| num_returns: This is only for *remote functions*. It specifies |
There was a problem hiding this comment.
Repeat of the problems above that technically these docstrings shouldn't be allowed based on the functions actual type definition. If we want to keep the original docstring, then I'm happy to revert and add back to the ignore list
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request performs a comprehensive update to docstrings and type hints across multiple Ray modules to enhance code documentation and type safety. The review identified a few areas for improvement, including correcting invalid type hint syntax, resolving inconsistencies between docstrings and function signatures regarding data types, and fixing argument order mismatches in docstrings.
Signed-off-by: Mark Towers <mark@anyscale.com>
Signed-off-by: Mark Towers <mark@anyscale.com>
# Conflicts: # ci/lint/pydoclint-baseline.txt # python/ray/_private/worker.py
Signed-off-by: Mark Towers <mark@anyscale.com>
pseudo-rnd-thoughts
requested review from
andrewsykim and
ryanaoleary
as code owners
2 participants
#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._privateignores then uses Claude to fix all the docstrings / type hints (and reviewed by me to confirm implementations).