Skip to content

Templates: python function

cmoeckel91 edited this page Nov 18, 2017 · 7 revisions

def function(arg1, arg2):
    """Summary line.
    
    Extended description of the function.
    
    Parameters
    ----------
    arg1 : int
        [Unit] Description of arg1
    arg2 : str
        [Unit] Description of arg2
    
    Keyword Arguments
    ----------
    pt1: type
       [Unit] Description, Default: true
    
    Returns
    -------
    out1 :
        [Unit] Description of return value
    out2 :
        [Unit] Description of return value
    
    Warnings
    -------
    
    
    Example
    -------
    text
    
    >>>function(arg1, arg2)
    out1
    
    References
    ------------
    <URL> / citation if applicable
    
    Todo
    ----- 
    
    Notes
    -------
    mm/dd/yy, Initials of Author, Short description of update
    """
    # Function 
    return [out1,out2]

Clone this wiki locally