Skip to content

openscm_calibration.operations#

Operations

This module is just there to help with doc building etc. on project creation. You will probably delete it early in the project.

Functions:

Name Description
add_two

Add two numbers

add_two #

add_two(a: float, b: float) -> float

Add two numbers

Parameters:

Name Type Description Default
a float

First number

 required
b float

Second number

 required

Returns:

Type Description
float

Sum of the numbers

Examples:

>>> add_two(1, 3)
4
>>> add_two(1, -3)
-2
Source code in src/openscm_calibration/operations.py 
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
def add_two(a: float, b: float) -> float:
    """
    Add two numbers

    Parameters
    ----------
    a
        First number

    b
        Second number

    Returns
    -------
    :
        Sum of the numbers

    Examples
    --------
    >>> add_two(1, 3)
    4
    >>> add_two(1, -3)
    -2
    """
    return a + b