Skip to content

Latest commit

 

History

History
28 lines (23 loc) · 422 Bytes

numpy.md

File metadata and controls

28 lines (23 loc) · 422 Bytes

Numpy Docstring Format

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

    Parameters
    ----------
    a : int
        _description_
    c : list, optional
        _description_, by default [1,2]

    Returns
    -------
    _type_
        _description_

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

    return c