PyCQA / pydocstyle

docstring style checker
http://pydocstyle.org
MIT License
1.11k stars 188 forks source link

6.2.1 Errors in doc verification of version #617

Closed 597038837 closed 1 year ago

597038837 commented 1 year ago
def func(
    a: int,
    b: list,
    c: int = None,
    d: bool = False,
    e: bool = False,
) -> list:
    """Commit.

    commit.

    Args:
        a (int): commit.
        b (list): commit.
        c (int): commit.
        d (bool): commit.
        e (bool): commit.

    Results:
        [list]: []
    """
    return []

pydocstyle=6.2.1 D417: Missing argument descriptions in the docstring (argument(s) b, c, d, e are missing descriptions in 'func' docstring)

pydocstyle=6.1.0 Pass

samj1912 commented 1 year ago

Duplicate of #618