docblockr.md

docBlockr Docstring Format

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

    Arguments:
        a {int} -- _description_

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

    Raises:
        AssertionError: _description_

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

    return c
    if a > 10:
        raise AssertionError("a is more than 10")

    return c