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 #379 Update known issues in UG regarding the issue of unable to differentiate hash data #393

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 @@ -4,6 +4,6 @@ Display | Name | Github Profile | Portfolio
--------|:--------:|:----------------------------------------:|:---------:
![](images/aboutUs/shanice.jpg) | Shanice | [Github](https://github.com/ShaniceTang) | [Portfolio](team/shanicetang.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)
![](docs/images/aboutUs/ziyi.jpg) | 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)
![](images/aboutUs/zhongheng.jpg) | Chua Zhong Heng | [Github](https://github.com/Cazh1/tp) | [Portfolio](team/cazh1.md)
4 changes: 2 additions & 2 deletions docs/DeveloperGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ In the Ui component,
### Parser component
API: [Parser.java](https://github.com/AY2324S1-CS2113-T17-2/tp/blob/master/src/main/java/seedu/cafectrl/parser/Parser.java)

![Parser Class Diagram](images/class/Parser.png)
![Parser Class Diagram](images/class/Parser.svg)
<br>*Figure 4: Parser Class Diagram*

The `Parser` component is responsible for interpreting the user's input and return appropriate `Command` for execution. If the input is unrecognisable, `Parser` will return an `IncorrectCommand` which will display error message to the user through `Ui`.
Expand All @@ -119,7 +119,7 @@ The `Parser` component is responsible for interpreting the user's input and retu

Below is the sequence diagram of a parser which shows how `Parser` parses user input:

![Parser Parsing User Input Sequence Diagram](images/sequence/Parser.png)
![Parser Parsing User Input Sequence Diagram](images/sequence/Parser_execute_command.svg)
<br>*Figure 5: Parser Parsing User Input Sequence Diagram*

When user input a string to `Main`, it passes the full user input to `Parser` via `parseCommand`. In `parseCommand`, it finds the matching keyword for different command from the user input, it calls the respective `prepareCommand` method within itself. `prepareCommand` then generates the corresponding command class and return it to `parseCommand`, which returns the `Command` back to `Main` for execution.
Expand Down
55 changes: 35 additions & 20 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,16 @@
* [Viewing help : `help`](#viewing-help--help)
* [Adding a dish : `add`](#adding-a-dish--add)
* [Deleting a dish : `delete`](#deleting-a-dish--delete)
* [Editing price of a dish : `edit_price`](#editing-price-of-a-dish--editprice)
* [Listing all dishes : `list_menu`](#listing-all-dishes--listmenu)
* [Listing ingredients needed for the selected dish : `list_ingredients`](#listing-ingredients-needed-for-the-selected-dish--listingredients)
* [Buying an ingredient : `buy_ingredient`](#buying-an-ingredient--buyingredient)
* [Viewing the total stock of ingredients : `view_stock`](#viewing-the-total-stock-of-ingredients--viewstock)
* [Adding an order : `add_order`](#adding-an-order--addorder)
* [Showing total sales : `list_total_sales`](#showing-total-sales--listtotalsales)
* [Showing sales for a chosen day : `list_sale`](#showing-sales-for-a-chosen-day--listsale)
* [Advancing to the next day: `next_day`](#advancing-to-the-next-day-nextday)
* [Returning to the previous day: `previous_day`](#returning-to-the-previous-day-previousday)
* [Editing price of a dish : `edit_price`](#editing-price-of-a-dish--edit_price)
* [Listing all dishes : `list_menu`](#listing-all-dishes--list_menu)
* [Listing ingredients needed for the selected dish : `list_ingredients`](#listing-ingredients-needed-for-the-selected-dish--list_ingredients)
* [Buying an ingredient : `buy_ingredient`](#buying-an-ingredient--buy_ingredient)
* [Viewing the total stock of ingredients : `view_stock`](#viewing-the-total-stock-of-ingredients--view_stock)
* [Adding an order : `add_order`](#adding-an-order--add_order)
* [Showing total sales : `list_total_sales`](#showing-total-sales--list_total_sales)
* [Showing sales for a chosen day : `list_sale`](#showing-sales-for-a-chosen-day--list_sale)
* [Advancing to the next day: `next_day`](#advancing-to-the-next-day-next_day)
* [Returning to the previous day: `previous_day`](#returning-to-the-previous-day-previous_day)
* [Exiting the program : `bye`](#exiting-the-program--bye)
* [Known Issues](#known-issues)
* [Command Summary](#command-summary)
Expand Down Expand Up @@ -413,16 +413,31 @@ Format: `bye`
----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
<!---@@author ziyi105--->
## Known Issues
- The application is unable to decode the data text files if they have been edited in the wrong decoding format.
- The application is unable to detect wrong argument tag, a general incorrect command format will be printed out for wrong argument tag.
- The application is unable to support unit conversion, hence only ml and g are accepted as ingredient unit and the use of unit must be constant for the same ingredient.
- The application is unable to save data for `Menu`, `Pantry` and `OrderList` if it is force exited using Ctrl+C command.
- The application currently accepts any valid dish name from orders.txt as a valid dish made on a given day, regardless of its presence in the current menu.
- This decision ensures that orders remain intact even if dishes are removed from the menu, allowing for a comprehensive record of all transactions.
- Restricting orders to only those present in the current menu would lead to unintentional deletion of orders containing dishes no longer available.
- Consideration was given to storing the names of dishes in the menu at the time the order was made in orders.txt.
- However, concerns about orders.txt becoming bloated with data were acknowledged.
- As this does not affect the functionality of any aspects of our application nor the logic of functions related to the content stored in orders.txt, we have decided that this can be considered in future improvements.
1. The application is unable to decode the data text files if they have been edited in the wrong decoding format.
2. The application is unable to detect wrong argument tag, a general incorrect command format will be printed out for wrong argument tag.
3. The application is unable to support unit conversion, hence only ml and g are accepted as ingredient unit and the use of unit must be constant for the same ingredient.
4. The application is unable to save data for `Menu`, `Pantry` and `OrderList` if it is force exited using Ctrl+C command.
5. The application currently accepts any valid dish name from orders.txt as a valid dish made on a given day, regardless of its presence in the current menu.
- This decision ensures that orders remain intact even if dishes are removed from the menu, allowing for a comprehensive record of all transactions.
- Restricting orders to only those present in the current menu would lead to unintentional deletion of orders containing dishes no longer available.
- Consideration was given to storing the names of dishes in the menu at the time the order was made in orders.txt.
- However, concerns about orders.txt becoming bloated with data were acknowledged.
- As this does not affect the functionality of any aspects of our application nor the logic of functions related to the content stored in orders.txt, we have decided that this can be considered in future improvements.
6. The application is unable to differentiate hash string that has been modified by user in the text file with normal data text.
- This leads the decoder of the text file to attempt to decode the modified hash string, hence resulting in an error message.
- This example illustrates the error message shown when the hash string in pantry_stock.txt is modified to 000000
- ```
Well, well, well, looks like someone's been playing with the save files!
Let's keep it classy and use the prescribed format below.

Format for Pantry_stock.txt:
{Ingredient Name} | {Ingredient Qty} | {Ingredient Unit}

pantry_stock.txt: Invalid format, this pantry stock will be removed -> 000000
Done loading pantry_stock.txt!
------------------------------------------------------------------------
```
7. If the user manually adds an order of dish that does not exist in menu to orders.txt, the order will still be generated but the new dish will not be added to the menu.

----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
## Command Summary
Expand Down
Binary file added docs/images/aboutUs/ziyi.jpg
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/class/Parser.png
Binary file not shown.
1 change: 1 addition & 0 deletions docs/images/class/Parser.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/Parser_execute_command.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading