astoria-tech / volunteer-dispatch

Slackbot to coordinate errand volunteering
MIT License
24 stars 9 forks source link

Document functions #50

Closed bronzehedwick closed 4 years ago

bronzehedwick commented 4 years ago

Add JSDoc comments to every function in the project. Add a JSDoc eslinter with recommended settings to keep the comment blocks properly formatted. This could allow us to easily generate an API documentation site.

ashryanbeats commented 4 years ago

I won’t be able to look at the changes until tomorrow or Wednesday (feel free not to wait on me). But to echo @bcosynot, thanks for taking the time to do this @bronzehedwick!!

bronzehedwick commented 4 years ago

No problem @ashryanbeats. And thanks @bcosynot for the review. I handled most of the suggestions but had a follow up on one above.

Thanks!

bronzehedwick commented 4 years ago

Thanks for the feedback @ashryanbeats and all the catches! I updated my PR and those issues should be resolved now.