griffe-unknown-param

Part of: Griffe Check

Check	griffe
Category	required
Applies to	functions, methods
Since	v1.0.0

Docstring documents a parameter not in the function signature

What it detects

This rule flags docstrings that document a parameter which does not exist in the function's actual signature. The check uses griffe's Google-style parser to compare documented parameters against the function definition.

Why is this a problem?

A documented parameter that doesn't exist in the signature is actively misleading. The parameter may have been renamed or removed during a refactor, leaving stale documentation that confuses callers. This also causes visible rendering errors on mkdocs documentation sites.

How to Fix

Remove or rename the documented parameter that does not exist in the function signature. Check if the parameter was renamed during a refactor and update the Args: entry to match the current parameter name, or delete the entry if the parameter was removed.

Example

ViolationFix

def send_request(url: str, retries: int = 3) -> Response:
    """Send an HTTP request.

    Args:
        url: Target URL.
        timeout: Request timeout in seconds.
        retries: Number of retry attempts.

    Returns:
        HTTP response object.
    """
    ...

def send_request(url: str, retries: int = 3) -> Response:
    """Send an HTTP request.

    Args:
        url: Target URL.
        retries: Number of retry attempts.

    Returns:
        HTTP response object.
    """
    ...