Add pydocstyle to the ruff rules (#52136)
Signed-off-by: Harry Mellor <19981378+hmellor@users.noreply.github.com> Signed-off-by: Harry Mellor <hej.mellor@gmail.com> Co-authored-by: Claude Opus 5 (1M context) <noreply@anthropic.com>
This commit is contained in:
co-authored by
Claude Opus 5
parent
804e5377aa
commit
8c1557a79c
@@ -98,8 +98,7 @@ mock_if_no_torch("torch", PydanticMagicMock(name="torch", nn=mock_nn))
|
||||
# Mock torch.library.infer_schema for vllm.ir.ops.IrOpInplaceOverload.__init__
|
||||
# We need to return the corresponding number of inputs, as IR infra will assert it
|
||||
def get_outputs(native_fn: Callable) -> str:
|
||||
"""
|
||||
Extract output schema from function's return type annotation,
|
||||
"""Extract output schema from function's return type annotation,
|
||||
e.g. 'Tensor' or 'Tensor, Tensor'.
|
||||
"""
|
||||
import typing
|
||||
@@ -249,11 +248,12 @@ def create_parser(add_cli_args, **kwargs) -> FlexibleArgumentParser:
|
||||
"""Create a parser for the given class with markdown formatting.
|
||||
|
||||
Args:
|
||||
cls: The class to create a parser for
|
||||
add_cli_args: The `add_cli_args` classmethod to build the parser from.
|
||||
**kwargs: Additional keyword arguments to pass to `cls.add_cli_args`.
|
||||
|
||||
Returns:
|
||||
FlexibleArgumentParser: A parser with markdown formatting for the class.
|
||||
|
||||
"""
|
||||
try:
|
||||
parser = FlexibleArgumentParser(add_json_tip=False)
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
# SPDX-FileCopyrightText: Copyright contributors to the vLLM project
|
||||
"""
|
||||
Generates documentation table for attention backends showing feature support.
|
||||
"""Generates documentation table for attention backends showing feature support.
|
||||
|
||||
This script parses all registered attention backends using AST (no imports needed)
|
||||
and generates a markdown table showing what features each backend supports,
|
||||
@@ -304,6 +303,7 @@ def parse_mla_prefill_registry() -> dict[str, str]:
|
||||
|
||||
Returns:
|
||||
A dict mapping backend names to their class paths.
|
||||
|
||||
"""
|
||||
if not MLA_PREFILL_REGISTRY_FILE.exists():
|
||||
return {}
|
||||
@@ -325,6 +325,7 @@ def parse_mla_prefill_priorities() -> dict[str, list[str]]:
|
||||
Returns:
|
||||
A dict with keys like 'blackwell' and 'default' containing
|
||||
lists of backend enum names in priority order.
|
||||
|
||||
"""
|
||||
if not MLA_PREFILL_SELECTOR_FILE.exists():
|
||||
return {}
|
||||
@@ -549,6 +550,7 @@ def parse_mla_prefill_backend_file(class_path: str) -> dict[str, Any] | None:
|
||||
|
||||
Returns:
|
||||
A dict with backend properties, or None if parsing fails.
|
||||
|
||||
"""
|
||||
file_path = get_file_from_class_path(class_path)
|
||||
if file_path is None:
|
||||
|
||||
@@ -49,8 +49,7 @@ def title(text: str) -> str:
|
||||
|
||||
@dataclass
|
||||
class Example:
|
||||
"""
|
||||
Example class for generating documentation content from a given path.
|
||||
"""Example class for generating documentation content from a given path.
|
||||
|
||||
Attributes:
|
||||
path (Path): The path to the main directory or file.
|
||||
@@ -64,6 +63,7 @@ class Example:
|
||||
|
||||
Methods:
|
||||
generate() -> str: Generates the documentation content.
|
||||
|
||||
"""
|
||||
|
||||
path: Path
|
||||
@@ -75,7 +75,8 @@ class Example:
|
||||
|
||||
If path is a file, it returns the path itself. If path is a directory, it
|
||||
searches for Markdown files (*.md) in the directory and returns the first one
|
||||
found. If no Markdown files are found, it returns None."""
|
||||
found. If no Markdown files are found, it returns None.
|
||||
"""
|
||||
# Single file example
|
||||
if self.path.is_file():
|
||||
return self.path
|
||||
@@ -90,7 +91,8 @@ class Example:
|
||||
"""Determine other files in the directory excluding the main file.
|
||||
|
||||
If path is a file, it returns an empty list. Otherwise, it returns every file
|
||||
in the directory except the main file in a list."""
|
||||
in the directory except the main file in a list.
|
||||
"""
|
||||
# Single file example
|
||||
if self.path.is_file():
|
||||
return []
|
||||
@@ -116,8 +118,7 @@ class Example:
|
||||
raise ValueError(f"Title not found in {self.main_file}")
|
||||
|
||||
def fix_relative_links(self, content: str) -> str:
|
||||
"""
|
||||
Fix relative links in markdown content by converting them to gh-file
|
||||
"""Fix relative links in markdown content by converting them to gh-file
|
||||
format.
|
||||
|
||||
Args:
|
||||
@@ -125,6 +126,7 @@ class Example:
|
||||
|
||||
Returns:
|
||||
str: Content with relative links converted to gh-file format
|
||||
|
||||
"""
|
||||
# Regex to match markdown links [text](relative_path)
|
||||
# This matches links that don't start with http, https, ftp, or #
|
||||
|
||||
@@ -35,6 +35,7 @@ def fill_markers(doc_path: str, blocks: dict[str, str]) -> None:
|
||||
FileNotFoundError: If the source page does not exist.
|
||||
ValueError: If an expected marker is missing, or any `gen:` marker is
|
||||
left unsubstituted after filling.
|
||||
|
||||
"""
|
||||
source = DOCS_DIR / doc_path
|
||||
if not source.exists():
|
||||
|
||||
Reference in New Issue
Block a user