From ee19c0b2cff1b21fcef42da7090468ae7d08a115 Mon Sep 17 00:00:00 2001 From: ItsTYtan Date: Wed, 15 Nov 2023 22:57:44 +0800 Subject: [PATCH 1/2] Change stuff --- docs/UserGuide.md | 34 +++++++++++++++------------------- 1 file changed, 15 insertions(+), 19 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index feabae86955..da3ff3a0097 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -189,7 +189,7 @@ If you are not sure how to use [Ba]king [Br]ead, this command will show a pop-up Format: `help` - +
@@ -220,8 +220,7 @@ Example Used: `add n/Flour q/1 u/kg` **Note**: Sample started with 3kg of Flour Example Used: `add n/Milk q/600 u/g` **Note**: Sample did not have any Milk in the stock. - - +
### Using up ingredients : `use` @@ -246,7 +245,7 @@ Examples: * `use n/Milk q/600 u/g` Depletes the current quantity of milk by 600g. * `use n/Egg` Fully depletes the current quantity of egg. -Example Used: `use n/Milk q/600 u/g` **Note**: Sample started with 1kg of Milk in the stock. +Example Used: `use n/Milk q/600 u/g` **Note**: Sample started with 1kg of Milk in the stock.
@@ -276,8 +275,7 @@ Examples: Example used: `stock butter` - - +
### Clearing all ingredients from ingredient stock : `clear` @@ -287,8 +285,7 @@ Format: `clear` Example used: `clear` - - +
### Listing all Recipes : `list` @@ -298,8 +295,7 @@ Format: `list` Example Used: `list` - - +
### Viewing Specific Recipes : `view` @@ -315,7 +311,7 @@ Examples: Example Used: `view 1` - +
@@ -342,7 +338,7 @@ complete recipe ``` * Name of Recipe needs to be of Alphanumeric format. -* Ingredients inputted **must** be of the format `(NAME) (QUANTITY)(UNIT)`, such as `flour 100g`. +* Ingredients specified **must** be of the format `(NAME) (QUANTITY)(UNIT)`, such as `flour 100g`. * The quantity of the ingredient must be positive and the unit must be supported. * For the recipe steps, the format to follow is `(STEP_NUMBER). (STEP)` such as `1. Mix Water and Flour`. * For the recipe steps, you should input the appropriate step number at each step, or the order of the steps may be incorrect in the completed recipe. @@ -350,7 +346,7 @@ complete recipe **Note**: There is no error message when inputting negative quantities for ingredients. As such, it is up to the user to ensure - that a positive quantity is inputted. + that a positive quantity is specified. Example: @@ -368,12 +364,12 @@ complete recipe -When encountering the error message `Failed to add ingredient`, ensure that the ingredient keyed in follows the following format **exactly** : `(NAME) (QUANTITY)(UNIT)` Example: `Milk 100g` +When encountering the error message `Failed to add ingredient`, ensure that the ingredient specified follows the following format **exactly** : `(NAME) (QUANTITY)(UNIT)` Example: `Milk 100g` -When encountering the error message `Failed to add step`, ensure that the index(A whole number) has been keyed been in before keying in the step itself
+When encountering the error message `Failed to add step`, ensure that the index(A whole number) has been specified been in before keying in the step itself
Example: `1. Mix Water and Flour` **Note**: Ensure that a period and space is present after the index. @@ -492,12 +488,12 @@ If your changes to the data file makes its format invalid, Inventory will discar | Error Message | What to do | |-----------------------------------|----------------------------------------------------------------------------------------| -| Unknown command | Ensure that the command keyed in is one of the commands mentioned within this document | -| Invalid Command Format | Ensure that all parameters have keyed in and that none are left empty | +| Unknown command | Ensure that the command specified is one of the commands mentioned within this document | +| Invalid Command Format | Ensure that all parameters have specified and that none are left empty | | Names should only contain alphanumeric characters and spaces, and it should not be blank | Ensure that only letters and numbers are used for names | -| Quantity has to be positive | Ensure that the quantity valued keyed in is **greater** than 0 | +| Quantity has to be positive | Ensure that the quantity value specified is **greater** than 0 | | There is no recipe with the recipe UUID provided in the recipe book | Check the UUID of recipe attempting to use and ensure that it is correct | -| The recipe UUID provided is invalid | Ensure that the UUID you have entered is valid (ie. it is a positive integer | +| The recipe UUID provided is invalid | Ensure that the UUID you have entered is valid (ie. it is a positive integer) | -------------------------------------------------------------------------------------------------------------------- From 73a83696f7911c3184d184dac7113735063d9645 Mon Sep 17 00:00:00 2001 From: ItsTYtan Date: Wed, 15 Nov 2023 23:08:14 +0800 Subject: [PATCH 2/2] Final changes --- docs/UserGuide.md | 45 ++++++++++----------------------------------- 1 file changed, 10 insertions(+), 35 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index caee9710388..e2ca0764797 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -122,6 +122,7 @@ into the application's input box as shown below.

3. You should see the ingredient added into your ingredient list as seen below. Hooray! You have added your first ingredient!

+
#### Adding your first recipe Recipe adding is a little more complicated! But don't worry, you will get the hang of it in no time! Refer to the infographic below for step-by-step instructions on adding your first recipe. @@ -217,16 +218,12 @@ Examples: Example Used: `add n/Flour q/1 u/kg` **Note**: Sample started with 3kg of Flour in the stock. - + Example Used: `add n/Milk q/600 u/g` **Note**: Sample did not have any Milk in the stock. -<<<<<<< HEAD
-======= - ->>>>>>> master ### Using up ingredients : `use` @@ -253,7 +250,7 @@ Examples: Example Used: `use n/Milk q/600 u/g` **Note**: Sample started with 1kg of Milk in the stock.
- +
@@ -281,11 +278,8 @@ Examples: Example used: `stock butter` -<<<<<<< HEAD
-======= ->>>>>>> master ### Clearing all ingredients from ingredient stock : `clear` @@ -295,12 +289,8 @@ Format: `clear` Example used: `clear` -<<<<<<< HEAD
-======= - ->>>>>>> master ### Listing all Recipes : `list` @@ -310,11 +300,7 @@ Format: `list` Example Used: `list` -<<<<<<< HEAD
-======= - ->>>>>>> master ### Viewing Specific Recipes : `view` @@ -330,10 +316,8 @@ Examples: Example Used: `view 1` -<<<<<<< HEAD
-======= ->>>>>>> master + @@ -383,23 +367,15 @@ steps start complete recipe ``` - - When encountering the error message `Failed to add ingredient`, ensure that the ingredient specified follows the following format **exactly** : `(NAME) (QUANTITY)(UNIT)` Example: `Milk 100g` - -<<<<<<< HEAD -When encountering the error message `Failed to add step`, ensure that the index(A whole number) has been specified been in before keying in the step itself
-======= ->>>>>>> master - Example: `1. Mix Water and Flour` **Note**: Ensure that a period and space is present after the index. +When encountering the error message `Failed to add step`, ensure that the index(A whole number) has been specified been in before keying in the step itself - **Caution:** As this function relies heavily on the user's input, please do check that your input is of the correct format. @@ -420,13 +396,13 @@ Example Used: `modify i/1 n/Flour q/100 u/g` **Note**: Recipe being modified has 200g of flour as part of the ingredient list - + Example Used: `modify i/1 n/Cream q/100 u/g` **Note**: Recipe being modified does not have cream in its ingredient list - + @@ -477,13 +453,12 @@ Examples: Example used: `search flour` **Note**: Multiple recipes use the ingredient flour - + Example used: `search blueberry` **Note**: Only one recipe uses the ingredient blueberry - - +
### Exiting the program : `exit` @@ -498,7 +473,7 @@ Inventory and Recipe data are saved in the hard disk automatically after any com **Note**: When the application loads for the first time and no command is run, no inventory or recipe data will be saved. - +
### Editing the data file Inventory data are saved automatically as a JSON file `[JAR file location]/data/inventory.json`. Advanced users are welcome to update data directly by editing that data file.