[CS2113-F11-2] EssenMakanan #35

StanleyW00 · 2023-10-11T01:07:31Z

No description provided.

tangzhenen · 2023-11-01T03:38:39Z

docs/DeveloperGuide.md

There can possibly be use of different types of UML diagrams instead of just one type.

methods in class diagrams also have many attributes and methods, maybe can remove irrelevant methods/attributes to improve readability

tangzhenen · 2023-11-01T03:40:19Z

docs/DeveloperGuide.md

@@ -14,25 +219,37 @@

 {Describe the target user profile}

+This product is for people who share kitchen space and ingredients with other cooks.


The target user profile could be more descriptive.

tangzhenen · 2023-11-01T03:41:32Z

docs/DeveloperGuide.md

@@ -1,11 +1,216 @@
+---


Maybe the use of short code snippets in the DG would be good for users to improve their understanding.

lisizhuang-0121 · 2023-11-01T04:11:05Z

docs/DeveloperGuide.md

+
+### Architecture
+
+<img src="images/ArchitectureDiagram.png" width="280" />


The architecture diagram hyperlink does not seem to work

lisizhuang-0121 · 2023-11-01T04:13:47Z

docs/DeveloperGuide.md

+| v1.0    | beginner user | add new recipes into the list     | learn and try out new recipes                |
+| v1.0    | beginner user | see all ingredient I have         |                                              |
+| v1.0    | beginner user | add ingredients to the empty list | add an item to my kitchen inventory          |
+| v2.0a   | amateur       | delete some recipes               | remove a recipe that I no longer want to use |


Perhaps could add more user stories for later versions

lisizhuang-0121 · 2023-11-01T04:20:28Z

docs/DeveloperGuide.md

+
+  `AddIngredientCommand` will call `Ui` class to print out the name of the recently added ingredient.
+
+<img src="images/AddNewIngredientSequenceDiagram.png" width="963" />


Perhaps the sequence diagrams for various commands could be combined, instead of having separate diagrams for each command, such as with alt blocks.

lisizhuang-0121 · 2023-11-01T04:23:51Z

docs/DeveloperGuide.md

+References
+1. Developer Guide: https://se-education.org/addressbook-level3/DeveloperGuide.html 
+2. User Guide: https://se-education.org/addressbook-level3/UserGuide.html
+3. 


Perhaps could remove point 3.

Barbaracwx · 2023-11-02T09:34:31Z

docs/DeveloperGuide.md

+
+### Architecture
+
+<img src="images/ArchitectureDiagram.png" width="280" />


Unable to see image of the architecture diagram

antrikshdhand

Sequence diagrams throughout your DG all seem to follow accepted practice including activation bars for self-invocations, dotted lines for return values, and constructor invocations. Lovely diagrams!

Barbaracwx · 2023-11-02T09:38:30Z

docs/DeveloperGuide.md

+- **Step1**
+
+  `AddRecipeCommand` will parse the recipe title using `RecipeParser`. Then, it will return the recipe title.
+
+
+- **Step2**
+
+  `AddRecipeCommand` will create a new `Recipe` with the obtained title.
+
+
+- **Step3**
+
+  `AddRecipeCommand` will add newly created `Recipe` into `RecipeList`. Then, the recipe will be added into an
+  `ArrayList` inside `RecipeList`.
+
+
+- **Step4**
+
+  `AddRecipeCommand` will call `Ui` class to print out the title of the recently added recipe.


Maybe for the addRecipeCommand, you can consider explaining how the title parsing and RecipeList work in more detail. Provide a step-by-step breakdown of the process, including the role of RecipeParser and RecipeList.

Barbaracwx · 2023-11-02T09:47:02Z

docs/DeveloperGuide.md

+| v1.0    | beginner user | add new recipes into the list     | learn and try out new recipes                |
+| v1.0    | beginner user | see all ingredient I have         |                                              |
+| v1.0    | beginner user | add ingredients to the empty list | add an item to my kitchen inventory          |
+| v2.0a   | amateur       | delete some recipes               | remove a recipe that I no longer want to use |

 ## Non-Functional Requirements


Maybe you can include a section or subsection on error handling to make the user understand. Explain how errors or exceptional cases are handled in the application. This can include user input validation, error messages, and how developers can handle exceptions in their code.

ShaniceTang

Overall very nice and neat DG! Good job! 👍

ShaniceTang · 2023-11-02T09:53:00Z

docs/DeveloperGuide.md

+  Finally `Ui#showCommands()` will call `Ui#showRecipeCommands()`, `Ui#showIngredientCommands()`, `Ui#showOtherCommands()` to print all commands for recipe, ingredient and others respectively
+
+
+<img src="images/HelpFunctionSequenceDiagram.png" width="732" />


Perhaps the command constructor could end here?

ShaniceTang · 2023-11-02T09:53:07Z

docs/DeveloperGuide.md

+- **Step 1**
+
+  Input will be sent from the main `EssenMakanan` class to the `Parser` to identify the command type
+
+
+- **Step 2**
+
+  A new `HelpCommand` object will be created and will be sent back to main
+
+
+- **Step 3**
+
+  `commandObject#executeCommand()` will be called which in turn calls `Ui#showCommands()`
+
+
+- **Step 4**
+
+  Finally `Ui#showCommands()` will call `Ui#showRecipeCommands()`, `Ui#showIngredientCommands()`, `Ui#showOtherCommands()` to print all commands for recipe, ingredient and others respectively


I like how you described the command step by step 👍

ShaniceTang · 2023-11-02T09:53:12Z

docs/DeveloperGuide.md

+
+The ***Architecture Diagram*** given above explains the high-level design of the App.
+
+Given below is a quick overview of main components and how they interact with each other.


Perhaps a sequence diagram could show how all the components interact with each other?

ShaniceTang · 2023-11-02T09:53:16Z

docs/DeveloperGuide.md

+
+### Architecture
+
+<img src="images/ArchitectureDiagram.png" width="280" />


Perhaps the link doesn't work?

# Conflicts: # src/main/java/essenmakanan/parser/Parser.java

Create shortcuts to add ingredients

Add JU test for Recipe Parser

Execute recipe function

Handle invalid ingredient adding, use ingredient command

Add appendix E

Fix number format bug for edit shortcut

Update appendix E

Update

Update dg

Update ug

Dg

Fix numbering

tangzhenen reviewed Nov 1, 2023

View reviewed changes

lisizhuang-0121 reviewed Nov 1, 2023

View reviewed changes

Barbaracwx reviewed Nov 2, 2023

View reviewed changes

antrikshdhand reviewed Nov 2, 2023

View reviewed changes

Barbaracwx reviewed Nov 2, 2023

View reviewed changes

ShaniceTang reviewed Nov 2, 2023

View reviewed changes

kaijie0102 and others added 23 commits November 11, 2023 00:03

Implement execute recipe command

0bbba68

Fix checkstyle

f9b6f03

Merge branch 'master' into branch-execute-recipe

6d707db

Fix merge conflicts

c0f6dc7

Merge branch 'master' into 240-shortcut-add-ingredients

2971872

# Conflicts: # src/main/java/essenmakanan/parser/Parser.java

Merge pull request #249 from StanleyW00/240-shortcut-add-ingredients

8d6b09f

Create shortcuts to add ingredients

Create charkty.md

0e0b7a8

Resolve merge conflicts

77ec82b

Merge pull request #247 from charkty/test

ee32536

Add JU test for Recipe Parser

Merge branch 'master' into team

0705fe5

Merge branch 'master' into team

4e3efc9

Fix merge conflict

77207f2

Fix merge conflict

877cd14

Merge pull request #248 from kaijie0102/branch-execute-recipe

a2b92e4

Execute recipe function

Fix merge conflicts

61e5e8e

Draft 1 of charkty.md

f402d08

Merge pull request #239 from kaijie0102/branch-ingredient-qty-unit

d70dc56

Handle invalid ingredient adding, use ingredient command

Edit recipe now works for multiple words

903814d

Merge branch 'master' into branch-edit-recipe

a105ebd

Merge branch 'master' into create-stanleyw00-ppp

4469cd5

Update logic

01f992c

Modify quantity checker

76132d7

Fix bug in parser

58db94e

kaijie0102 and others added 30 commits November 15, 2023 00:48

Merge branch 'master' of https://github.com/AY2324S1-CS2113-F11-2/tp

a2abcff

Merge pull request #303 from kaijie0102/master

da8bbb8

Add appendix E

Merge

6112202

Merge branch 'master' of https://github.com/AY2324S1-CS2113-F11-2/tp

8ff3dbd

Fix number format bug for edit shortcut

e236957

Formatting

b102ad0

Merge pull request #306 from StanleyW00/300-edit-shortcut-duplicate

b140fab

Fix number format bug for edit shortcut

Merge pull request #305 from kaijie0102/master

7dc9931

Update appendix E

Update

951b743

Update

dee97a9

Update

3054d33

Update

eeb9b61

Merge pull request #307 from charkty/dg

ea9c3bc

Update

Fix broken links

6aa5dcc

Update bullet points

ed42063

Merge pull request #308 from kaijie0102/master

ead47c4

Update dg

Update ug

b875594

Merge branch 'master' into dg

4eb0576

Update dg

3716954

Merge pull request #309 from charkty/dg

d0a21ce

Update ug

udpate dg

43af464

Update user story table

da84b84

Merge pull request #310 from charkty/dg

c263385

Dg

reformat table

9846ed6

Remove spaces

58a59ef

Merge pull request #311 from charkty/dg

07aa409

Dg

Fix numbering

65cbef7

Merge pull request #312 from charkty/dg

5c8c03c

Fix numbering

Fix numbering

1daf1ce

Merge pull request #313 from charkty/dg

6a76eeb

Fix numbering

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[CS2113-F11-2] EssenMakanan #35

[CS2113-F11-2] EssenMakanan #35

StanleyW00 commented Oct 11, 2023

tangzhenen Nov 1, 2023

Hongzhii Nov 2, 2023

tangzhenen Nov 1, 2023

tangzhenen Nov 1, 2023

lisizhuang-0121 Nov 1, 2023

lisizhuang-0121 Nov 1, 2023

lisizhuang-0121 Nov 1, 2023

lisizhuang-0121 Nov 1, 2023

Barbaracwx Nov 2, 2023

antrikshdhand left a comment

Barbaracwx Nov 2, 2023

Barbaracwx Nov 2, 2023

ShaniceTang left a comment

ShaniceTang Nov 2, 2023

ShaniceTang Nov 2, 2023

ShaniceTang Nov 2, 2023

ShaniceTang Nov 2, 2023

		@@ -14,25 +219,37 @@

		{Describe the target user profile}

		This product is for people who share kitchen space and ingredients with other cooks.


		### Architecture

		<img src="images/ArchitectureDiagram.png" width="280" />


		`AddIngredientCommand` will call `Ui` class to print out the name of the recently added ingredient.

		<img src="images/AddNewIngredientSequenceDiagram.png" width="963" />

		Finally `Ui#showCommands()` will call `Ui#showRecipeCommands()`, `Ui#showIngredientCommands()`, `Ui#showOtherCommands()` to print all commands for recipe, ingredient and others respectively


		<img src="images/HelpFunctionSequenceDiagram.png" width="732" />


		The *Architecture Diagram* given above explains the high-level design of the App.

		Given below is a quick overview of main components and how they interact with each other.

[CS2113-F11-2] EssenMakanan #35

Are you sure you want to change the base?

[CS2113-F11-2] EssenMakanan #35

Conversation

StanleyW00 commented Oct 11, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

antrikshdhand left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ShaniceTang left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment