Luke-Fanguna / FoodForLesser

0 stars 0 forks source link

Code Review Comments (Andrew Ji) #38

Open DrewskiG123 opened 10 months ago

DrewskiG123 commented 10 months ago
  1. Unless you have a future use planned, why keep empty files? admin, audit, barrel, and catalog are all blank.
  2. Maybe rename your update function in crowdsourcing.py to something more related to what it does, because it is still named get_bottle_plan.
  3. Maybe name your query results more specifically, like "compList" for a comparison list instead of "res" or "items"
  4. There should probably be more than 1 branch, so that issues and other features can be worked on without potentially breaking the "main" branch, especially if your render or whatnot automatically grabs the latest commit from github.
  5. I think out of all of your source files, you only use one docstring, even though most of your methods have the triple-quotes for them. Make use of those, it increases readability and aids collaboration.
  6. Column "created_at" does not need a value inserted by you because it will automatically fill with the current time as default. You can even set this to a specific time zone.
  7. You could further modularize your code with some helper functions in store.py just to keep the different steps isolated.
  8. Setting an item price to 999999, while it may work great, does not seem like the best way to implement your code. Again, further modularizing that code may help with this.
  9. Your API Router for store.py is still "/list", even though the methods use "/store"
  10. Your list entry delete currently uses a posting_id, but your API Spec says it is supposed to use a name. Just do a small update in the spec to match.
  11. Maybe standardize your formatting/indents, it kinda varies.
  12. As silly as it seems, I liked the few comments you added in store.py. Add more comments in parts of the code that are more complicated throughout your files.