Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[CS2113-T16-3] Expiry Eliminator #37

Open
wants to merge 513 commits into
base: master
Choose a base branch
from

Conversation

bernardboey
Copy link

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.

vincentlauhl and others added 26 commits October 26, 2021 12:24
Add.puml diagram for ListIngredientsExpired command
Add sequence diagram for ShoppingListCommand.
Add sequence diagram for ViewIngredientCommand.
Add sequence diagram for UpdateUnitsComand.
… the ingredients are expired for the recipe they can cook
…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
@bernardboey bernardboey changed the title [CS2113T-T16-3] Expiry Eliminator [CS2113-T16-3] Expiry Eliminator Oct 27, 2021
Copy link

@Alvinlj00 Alvinlj00 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

docs/DeveloperGuide.md Outdated Show resolved Hide resolved
docs/DeveloperGuide.md Outdated Show resolved Hide resolved
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.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would it be clearer if this was in point form instead?




## Implementation

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could a table of commands be added so that navigation through different commands would be easier?

@@ -4,15 +4,170 @@

{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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would you consider including some class or object diagrams to illustrate how these components work?

bernardboey and others added 30 commits November 8, 2021 21:14
Minor update to manual testing for launch.
# Conflicts:
#	docs/UserGuide.md
Update user guide and other documentation
Update to Instructions for Manual Testing for clarity
Add JavaDoc comments and more tests
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants