[CS2113-T16-3] Expiry Eliminator - #37
Open
bernardboey wants to merge 513 commits into
Open
Conversation
Bugfix cooked recipe
Add.puml diagram for ListIngredientsExpired command
…Cook, CookedRecipe, and Data
Add sequence diagram for ShoppingListCommand. Add sequence diagram for ViewIngredientCommand. Add sequence diagram for UpdateUnitsComand.
Dg update2
… the ingredients are expired for the recipe they can cook
…nt Repository saved to the file.
…rCanCook Check expiry date for recipes user can cook
Update sequence diagram for List Update sequence diagram for ListIngredientsExpired Update sequence diagram for ShoppingList Update sequence diagram for UpdateUnits Update sequence diagram for ViewIngredient
Sequence diagram branch
bernardboey
changed the title
Alvinlj00
reviewed
Oct 27, 2021
Alvinlj00
left a comment
Alvinlj00
left a comment
There was a problem hiding this comment.
Overall, it is a well-structured DG with clear headers and diagrams within each section. It might be better if, for each feature, the explanation is less wordy and in point form or steps.
Comment on lines
+38
to
+43
| The list expired ingredients feature is performed by `IngredientRepository`. It loops through all the | ||
| ingredient storages. For each ingredient storage, it gets the type of ingredient being stored in that | ||
| storage, and creates an empty storage for that ingredient type to store the batches of that ingredient | ||
| that are expired. The code then loops through all the batches of that ingredients, and add the expired | ||
| batches to the expire ingredient storage. The expired ingredient storage is converted into a string and | ||
| is shown as the output. Below is the sequence diagram for how list expired ingredients works. |
There was a problem hiding this comment.
Would it be clearer if this was in point form instead?
|
|
||
|
|
||
|
|
||
| ## Implementation |
There was a problem hiding this comment.
Could a table of commands be added so that navigation through different commands would be easier?
| {list here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the original source as well} | ||
|
|
||
| ## Design & implementation | ||
| ## Design |
There was a problem hiding this comment.
Would you consider including some class or object diagrams to illustrate how these components work?
…file each time the command executes.
Minor update to manual testing for launch.
# Conflicts: # docs/UserGuide.md
Update user guide and other documentation
Add authorship
Fix spelling errors in DG
Update to Instructions for Manual Testing for clarity
Update documentation
Add JavaDoc comments and more tests
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
8 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Expiry Eliminator is a desktop app for managing the freshness of ingredients in your kitchen and the recipes you want to cook, optimized for use via a Command Line Interface (CLI). If you are a young adult who is living in your own home and you can type fast, Expiry Eliminator can help you manage your ingredients and recipes quickly.