FlixPicks-Orange / FlixPicks-Front

0 stars 0 forks source link

Add Comments and Testing #5

Open ChanceSadler opened 7 months ago

ChanceSadler commented 7 months ago

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:

## @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.

ChanceSadler commented 7 months ago

This issue is true for all repositories, but I haven't looked through much of the backend.