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

Task 387, Edit UG #388

Merged
merged 3 commits into from
Nov 13, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/AboutUs.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Display | Name | Github Profile | Portfolio
--------|:--------:|:----------------------------------------:|:---------:
![](images/aboutUs/shanice.jpg) | Shanice | [Github](https://github.com/ShaniceTang) | [Portfolio](team/shanicetang.md)
![](https://via.placeholder.com/100.png?text=Photo) | Naychi | [Github](https://github.com/NaychiMin/tp) | [Portfolio](team/naychimin.md)
![](images/aboutUs/naychimin.png) | Naychi | [Github](https://github.com/NaychiMin/tp) | [Portfolio](team/naychimin.md)
![](https://via.placeholder.com/100.png?text=Photo) | Zi Yi | [Github](https://github.com/ziyi105) | [Portfolio](team/ziyi105.md)
<img height="100" src="images/aboutUs/dexter.jpg" width="100"/> | Dexter Hoon | [Github](https://github.com/DextheChik3n) | [Portfolio](team/dexthechik3n.md)
![](https://via.placeholder.com/100.png?text=Photo) | Chua Zhong Heng | [Github](https://github.com/Cazh1/tp) | [Portfolio](team/cazh1.md)
8 changes: 4 additions & 4 deletions docs/DeveloperGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -259,7 +259,7 @@ To end off the command, `ui.showPreviousDay()` is run to display a message to th
The user is also shown the receded day number.

### List Ingredients
![List Ingredient Execution](images/sequence/ListIngredientCommand_execute.png)
![List Ingredient Execution](images/sequence/ListIngredientCommand_execute.svg)
<br>*Figure 17: Execution of `list_ingredient` Command Sequence Diagram*

API: [ListIngredientCommand.java](https://github.com/AY2324S1-CS2113-T17-2/tp/blob/master/src/main/java/seedu/cafectrl/command/ListIngredientCommand.java)
Expand All @@ -274,7 +274,7 @@ Although it may seem tedious the steps are essentially as listed below:
- The `Ui` class showcases the information to the user through the `formatListIngredient()` method.

### List Sale By Day
![List_Sale Execution](images/sequence/ShowSaleByDayCommand_execute.png)
![List_Sale Execution](images/sequence/ListSaleByDayCommand_execute.svg)
<br>*Figure 18: Execution of `list_sale` Command Sequence Diagram*

API: [ListSaleByDayCommand.java](https://github.com/AY2324S1-CS2113-T17-2/tp/blob/master/src/main/java/seedu/cafectrl/command/ListSaleByDayCommand.java)
Expand All @@ -293,7 +293,7 @@ The steps are essentially as listed below:
* The List Total Sales command follows a comparable sequence, and as such, it will be excluded to avoid the repetition of multiple similar diagrams.

### Pantry - isDishCooked()
![isDishCooked_function](images/sequence/Pantry_IsDishCooked.png)
![isDishCooked_function](images/sequence/Pantry_IsDishCooked.svg)
<br>*Figure 19: Data Processing of `isDishCooked()` Function Used in `add_order` Command Sequence Diagram*

API: [Pantry.java](https://github.com/AY2324S1-CS2113-T17-2/tp/blob/master/src/main/java/seedu/cafectrl/data/Pantry.java)
Expand All @@ -309,7 +309,7 @@ The steps are essentially as listed below:
- A `false` indicates that the order was unsuccessful while a `true` indicates that the order was successful.

### Pantry - calculateMaxDish()
![calculateMaxDish_function](images/sequence/Pantry_CalculateMaxDish.png)
![calculateMaxDish_function](images/sequence/Pantry_CalculateMaxDish.svg)
<br>*Figure 20: Data Processing of `calculateMaxDish()` Function Used in `add_order` Command Sequence Diagram*

API: [Pantry.java](https://github.com/AY2324S1-CS2113-T17-2/tp/blob/master/src/main/java/seedu/cafectrl/data/Pantry.java)
Expand Down
17 changes: 7 additions & 10 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -327,31 +327,28 @@ Example: `list_total_sales`

Output:
- list_total_sales lists the dishes sold along with the total sales for every operating day of the cafe.
- in this case, the cafe has operated for two days.

```
+---------------------------------------------------------------------------+
Day 1:
+---------------------------------------------------------------------------+
| Day 1: |
+----------------------------------------+--------------+-------------------+
| Dish Name | Dish Qty | Total Cost Price |
+----------------------------------------+--------------+-------------------+
| chicken chop | 3 | 6.00 |
| chicken sandwhich | 7 | 21.00 |
| Chicken Rice | 2 | 5.00 |
| Chicken Nuggets | 4 | 6.00 |
+---------------------------------------------------------------------------+
| Total for day: | $27.00 |
| Total for day: | $11.00 |
+---------------------------------------------------------------------------+
Day 2:
+---------------------------------------------------------------------------+
| Day 2: |
+----------------------------------------+--------------+-------------------+
| Dish Name | Dish Qty | Total Cost Price |
+----------------------------------------+--------------+-------------------+
| chicken chop | 2 | 4.00 |
| chicken sandwhich | 2 | 6.00 |
| chicken noodles | 1 | 2.00 |
| Chicken Rice | 2 | 5.00 |
| Chicken Nuggets | 3 | 4.50 |
+---------------------------------------------------------------------------+
| Total for day: | $12.00 |
| Total for day: | $9.50 |
+---------------------------------------------------------------------------+
```

Expand Down
Binary file added docs/images/aboutUs/naychimin.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
1 change: 1 addition & 0 deletions docs/images/sequence/ListIngredientCommand_execute.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/images/sequence/ListSaleByDayCommand_execute.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/images/sequence/Pantry_CalculateMaxDish.png
Binary file not shown.
1 change: 1 addition & 0 deletions docs/images/sequence/Pantry_CalculateMaxDish.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/images/sequence/Pantry_IsDishCooked.png
Binary file not shown.
Loading