BCStudentSoftwareDevTeam / celts

Web app to support the CELTS program at Berea College
BSD 3-Clause "New" or "Revised" License
1 stars 8 forks source link

Add docstrings and comments if necessary to files in the events logic file #1132

Open bledsoef opened 7 months ago

bledsoef commented 7 months ago

This is a low priority issue lets save this for the summer cohort

There are a few instances in the app/logic/events.py file where we have functions without docstings, without good docstrings, or without good comments.

Reference the documentation for how to properly document code.

Places with poor code documentation:

bledsoef commented 7 months ago

Add docstrings and comments if necessary to files in the events logic file

thealphagurlux commented 2 months ago

Me and John re-analyzed the comments and function descriptions, getting rid of redundant descriptions (Like delete event pretty much describes itself) and double checked to make sure that parameter types are the same as their descriptions.