solorice/vscodium/extensions/njpwerner.autodocstring-0.6.1/docs/pep257.md

Pep257 Docstring Format

def abc(a: int, c = [1,2]):
    """_summary_

    Arguments:
        a -- _description_

    Keyword Arguments:
        c -- _description_ (default: {[1,2]})

    Raises:
        AssertionError: _description_

    Returns:
        _description_
    """
    if a > 10:
        raise AssertionError("a is more than 10")

    return c