2022-Spring-NYU-DevOps-Shopcarts / shopcarts

Shopcarts squad.
Apache License 2.0
2 stars 2 forks source link

Update Docstring for routes.py #60

Closed TimothyXu closed 2 years ago

TimothyXu commented 2 years ago

As a Developer I need understand what functionalities our API offers by reading the code So that that I can use it to perform business operations.

Details and Assumptions

Acceptance Criteria

 Given the Flask server is running
 When we read the doctoring of routes.py
 Then we see a brief description of our routes
TimothyXu commented 2 years ago

Per HW1 the root url response needs to be: the name, version, and what your resource URL is. We already have these so don't need to update the root URL response but the docstring still needs to be updated

yjjw commented 2 years ago

Actually I think after we refactored the code to RESTX, the comments we have is already self-explanatory and sufficient? I personally don't think we should explain how to honcho start in our code file (should be in README), what do you think?

TimothyXu commented 2 years ago

I agree we mostly don't need to do anything. There are some minor typos/errors I'll fix in like 30 minutes