vkoves / carpe

Scheduling for the modern age - an UNMAINTAINED indigoBox project
http://carpe-uno.herokuapp.com
0 stars 0 forks source link

Update All Javscript Comments to Be JsDoc Compliant #142

Closed Watercycle closed 6 years ago

Watercycle commented 7 years ago

In schedule.js, several of the functions are not using JSDOC (e.g. createBreak, convertTo12Hour, setHeight, etc). They should be updated to make use of JSDOC.

On that note, several functions (e.g. deleteEvent, dateToTimeString, saveCategory, etc) do not have any high level documentation at all. How thorough do we want to be?

rjaltman commented 6 years ago

We've since had PR #188 to address this issue, so perhaps we should check in again to make sure we addressed documentation as thoroughly as hoped. I know that a few people were closely observing the work done there, so they could probably tell the status of this a lot easier than I can at this point 😜.

vkoves commented 6 years ago

I'll take on reviewing this to see if we can close this issue.

vkoves commented 6 years ago

From looking at our JSDoc, it looks like everything has proper documentation :tada: I'll be closing this issue

vkoves commented 6 years ago

Based on my comment above, and Kyle completing scheduler documentation in #188, I am closing this