Skip to content

Commit

Permalink
Merge pull request #310 from charkty/dg
Browse files Browse the repository at this point in the history 
Dg
  • Loading branch information
@kaijie0102
kaijie0102 authored Nov 15, 2023
2 parents d0a21ce + da84b84 commit c263385
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions docs/DeveloperGuide.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -69,16 +69,19 @@ exactly one `RecipeStepList`.
Two main functionalities that we have are to `add` and `delete` a recipe from the recipeList. Below is an object diagram to illustrate how the add and delete function works.

1. The initial state of `recipes:RecipeList` stores 2 `Recipe`, namely, 'chicken pizza' and 'meatball noodles'

![RecipeListInitialState](images/RecipeListInitialState.png)


2. `Add` a new recipe
A new recipe titled "dumpings" will be added to `recipes:RecipeList`. The number of `recipe` stored in `recipes:RecipeList` will increase from 2 to 3.

![RecipeListAdd](images/RecipeListAdd.png)


3. `Delete` an existing recipe
Recipe titled "chicken pizza" is at index 2 of the `RecipeList`. By giving the command `delete r/2`, `recipes:RecipeList` will remove `chicken pizza:Recipe` from the ArrayList of recipes.

![RecipeListDelete](images/RecipeListDelete.png)

---
Expand Down Expand Up @@ -671,7 +674,7 @@ Easy and intuitive way to keep track of ingredients you have in your kitchen. Th
| v2.0a | new user | be greeted with an instruction manual | learn how to navigate through the app |
| v2.0a | beginner user | view specific recipe |
| v2.0a | beginner user | add ingredients to recipe |
|v2.0a| amateur | edit ingredients of recipe |edit a recipe I have created| change recipe ingredients |
|v2.0a| amateur | edit ingredients of recipe | change recipe ingredients| |
|v2.0a | amateur edit steps of recipe | edit a recipe I have created | change recipe steps |
|v2.0a| beginner user | type the quantity of ingredients as well as the unit of measurement | add an item with the quantity to my kitchen inventory |
|v2.0a| amateur | change the quantity of ingredient available | remove a fixed quantity of an ingredient from the list |
Expand All @@ -685,7 +688,7 @@ Easy and intuitive way to keep track of ingredients you have in your kitchen. Th
|v2.1| advanced user | cook for more if necessary | scale recipe based on number of pax |
|v2.1| advanced user | subtract ingredients automatically when i use it | indicate that i have used an ingredient |
|v2.1| expert | can categorise recipes based on ingredients I have | cook without purchasing new ingredients |
|v2.1| advanced user | add shortcuts to add commonly used ingredients | make the process of adding ingredients more efficient. |
|v2.1| advanced user | add shortcuts to add commonly used ingredients | make the process of adding ingredients more efficient. |


<a id="non-functional"></a>
Expand Down

0 comments on commit c263385

Please sign in to comment.