API Reference¶
This is a reference of for various aspects of the Python-Prefab codebase. API docs, code coverage and other resources are provided.
Code Coverage¶
A code coverage report is compiled from unit test using Coverage.
Link to the code coverage report.
API Auto Docs¶
Backend Module Docs¶
- src.backend.main_backend.dummy_function_back_end(x: str) str
A sample docstring using pep-0257 (https://peps.python.org/pep-0257/) formatting
- Parameters:
x (str) – a dummy string
- Returns:
a dummy string
- Return type:
str
Frontend Module Docs¶
- src.frontend.main_frontend.dummy_function_front_end(x: str) str
A sample docstring using pep-0257 (https://peps.python.org/pep-0257/) formatting
- Parameters:
x (str) – a dummy string
- Returns:
a dummy string
- Return type:
str