Skip to content

Commit f2a7a94

Browse files
authored
Update pydoclint to version 0.8.1 (#58490)
## Description * Does the work to bump pydoclint up to the latest version * And allowlist any new violations it finds ## Related issues n/a ## Additional information n/a --------- Signed-off-by: Thomas Desrosiers <thomas@anyscale.com>
1 parent 10983e8 commit f2a7a94

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

.pre-commit-config.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ repos:
4848
# pydoclint-local is for local commits only due to pre-commit-hook only passing
4949
# updated files to the hook and overwriting the baseline text file
5050
- repo: https://github.com/jsh9/pydoclint
51-
rev: "0.6.6"
51+
rev: "0.8.1"
5252
hooks:
5353
- id: pydoclint
5454
name: pydoclint-local
@@ -72,7 +72,7 @@ repos:
7272

7373
# pydoclint-ci is for CI, overwrites the baseline text file, and is run with the manual stage flag
7474
- repo: https://github.com/jsh9/pydoclint
75-
rev: "0.6.6"
75+
rev: "0.8.1"
7676
hooks:
7777
- id: pydoclint
7878
name: pydoclint-ci

ci/lint/pydoclint-baseline.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1484,9 +1484,6 @@ python/ray/llm/_internal/common/utils/download_utils.py
14841484
DOC201: Function `get_model_location_on_disk` does not have a return section in docstring
14851485
DOC201: Method `CloudModelDownloader.get_model` does not have a return section in docstring
14861486
--------------------
1487-
python/ray/llm/_internal/serve/configs/openai_api_models.py
1488-
DOC201: Function `to_model_metadata` does not have a return section in docstring
1489-
--------------------
14901487
python/ray/llm/_internal/serve/observability/metrics/middleware.py
14911488
DOC106: Function `_get_route_details`: The option `--arg-type-hints-in-signature` is `True` but there are no argument type hints in the signature
14921489
DOC107: Function `_get_route_details`: The option `--arg-type-hints-in-signature` is `True` but not all args in the signature have type hints
@@ -2194,6 +2191,9 @@ python/ray/tune/search/searcher.py
21942191
DOC201: Method `Searcher.set_max_concurrency` does not have a return section in docstring
21952192
--------------------
21962193
python/ray/tune/search/variant_generator.py
2194+
DOC101: Function `generate_variants`: Docstring contains fewer arguments than in function signature.
2195+
DOC103: Function `generate_variants`: Docstring arguments are different from function arguments. (Or could be other formatting issues: https://jsh9.github.io/pydoclint/violation_codes.html#notes-on-doc103 ). Arguments in the function signature but not in the docstring: [constant_grid_search: bool, random_state: 'RandomState', unresolved_spec: Dict].
2196+
DOC404: Function `generate_variants` yield type(s) in docstring not consistent with the return annotation. The yield type (the 0th arg in Generator[...]/Iterator[...]): Tuple[Dict, Dict]; docstring "yields" section types:
21972197
DOC201: Function `grid_search` does not have a return section in docstring
21982198
--------------------
21992199
python/ray/tune/search/zoopt/zoopt_search.py

0 commit comments

Comments
 (0)