Reference¶
arneso_pypitemplate_instance package¶
arneso_pypitemplate_instance.functions module¶
A collection of useful functions.
The template and this example uses Google style docstrings as described at: https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html
- example_function(number1, number2)¶
Compare two integers.
This is merely an example function can be deleted. It is used to show and test generating documentation from code, type hinting, testing, and testing examples in the code.
- Parameters:
number1 (
int) – The first number.number2 (
int) – The second number, which will be compared to number1.
- Return type:
str- Returns:
A string describing which number is the greatest.
Examples
Examples should be written in doctest format, and should illustrate how to use the function.
>>> example_function(1, 2) 1 is less than 2