Documentation¶
The documentation page lists out all of the relevant classes and functions in a package.
Package¶
The package section documents all of the code in the __init__.py
file. If you put any code in that file, it will show up
here.
- package.example_package_function(num: int) int¶
Squares the input number and returns the result.
- Parameters
num (int) – a number
- Returns
the square of the input
Module¶
The module section documents all of the code in a particular
Python file. Specifically, all of the code below is
documented from the module.py file.
- package.module.example_module_function(name: str) str¶
Generates a string including a name.
- Parameters
name (str) – the name of someone
- Returns
a string in the form ‘Hello, my name is {name}’