Description:
There is a lack of comments across pretty much all the code. Additionally there is a lack of testing. This issue is meant as a reminder to make code more readable and to create tests.
Acceptance Criteria:
Majority of code has comments or is written in a way that doesn't require comments
Every function should have a minimal doxygen comment
Every function should have a corresponding test case
Notes:
Example Function comment:
## @package pyexample
# Documentation for this module.
#
# More details.
## Documentation for a function.
#
# More details.
Not every function will need documentation, but every function should be described at least a little. Any variables that are not named in a way that make it not immediately apparent should have a small comment.
The majority of the app routes are readable, but could use function comments.
Description: There is a lack of comments across pretty much all the code. Additionally there is a lack of testing. This issue is meant as a reminder to make code more readable and to create tests. Acceptance Criteria:
Notes: Example Function comment:
Not every function will need documentation, but every function should be described at least a little. Any variables that are not named in a way that make it not immediately apparent should have a small comment.
The majority of the app routes are readable, but could use function comments.