SUBTRACT Module#

api.subtract module

pmps.api.subtract.subtract(num1, num2)[source]#

Subtract up two integer numbers.

This function simply wraps the - operator, and does not do anything interesting, except for illustrating what the docstring of a very simple function looks like.

Parameters

num1 (int) – First number.
num2 (int) – Second number to subtract.

Returns

The subtraction of num1 and num2.

Return type

int

See also

subtract: Subtract one integer from another.

Examples

>>> core_subtract(2, 2)
4
>>> core_subtract(25, 0)
25
>>> core_subtract(10, -10)
0