Source code for besca.examples.example_function

def function_name(
    param1="default_value1", param2="default_value2", param3="default_value3"
):
    """one-line function description that shows up in summaries.

    more extensive multi line function description explaining exactly what the function
    does and is intended for examples for code execution of the function can also be
    provided here

    Parameters
    ----------
    param1: `type` | default = default_value1
        brief description of what param1 controls and to what it should be set
    param2: `type` | default = default_value2
        brief description of what param1 controls and to what it should be set
    param3: `type` | default = default_value3
        brief description of what param1 controls and to what it should be set

    Returns
    -------
    Type
        Information on what the function returns

    Example
    -------

    >>> #insert example code here
    >>> 1 + 1
    2
    
    # this code is only displayed not executed

    """

    # function body
    # do something here