Open bledsoef opened 7 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.
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:
cancelEvent
(poor docstring)deleteEventAndAllFollowing
anddeleteAllRecurringEvents
(no comments, could be a little bit confusing)saveEventToDb
(no docstring, very few comments)getStudentLedEvents
(no docstring, maybe a few lines)