Merge pull request #395 from NaychiMin/Edit-UG-v2.1

Update formatting of user guide and PPP
AY2324S1-CS2113-T17-2 · Nov 13, 2023 · 7e02db4 · 7e02db4
2 parents 234c862 + 90e66d7
commit 7e02db4
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 6 deletions.
diff --git a/docs/UserGuide.md b/docs/UserGuide.md
@@ -47,6 +47,7 @@ _/        _/    _/    _/      _/        _/          _/      _/        _/
 ------------------------------------------------------------------------
 > 
 ```
+
 ---------------------------------------------------
 <!---@@author ziyi105--->
 ## Summary
@@ -228,7 +229,8 @@ Lists out the ingredients needed along with the quantity for a specific dish
 Format: `list_ingredients dish/DISH_INDEX`
 
 Example:
-- list followed by list_ingredients dish/1 lists the ingredients of the 1st dish on the menu
+- list followed by list_ingredients index/1 lists the ingredients of the 1st dish on the menu
+
 ```
 +-------------------------------------------------------+
 |Dish: chicken rice                                     |
@@ -241,7 +243,6 @@ Example:
 +-------------------------------------------------------+
 ```
 
-
 ### Buying an ingredient : `buy_ingredient`
 Adds one or more ingredients to the pantry
 
@@ -262,7 +263,6 @@ Ingredient: chicken
 Total Qty: 500g
 ```
 
-
 <!---@@author ShaniceTang--->
 ### Viewing the total stock of ingredients : `view_stock`
 Displays the available stock of all the ingredients found in the pantry
@@ -368,7 +368,6 @@ Example: `list_sale day/2`
 Output:
 - list_sale day/2 lists the dishes sold along with the total sales for day 2.
 
-
 ```
 +---------------------------------------------------------------------------+
 | Day 2:                                                                    |

diff --git a/docs/team/naychimin.md b/docs/team/naychimin.md
@@ -62,12 +62,12 @@ Café proprietors who prefer typing on CLI than any other interaction method and
 
 2. **Encoding of Sales**
     - Implemented encoding for the Sales object, involving:
-        - Parsing through various attributes of the Sales object using the delimiter '|'.
+        - Parsing through various attributes of the Sales object using the delimiter `|`.
         - Storing the data in a text file.
 
 3. **Decoding of Sales**
     - Executed decoding for the Sales object, encompassing:
-        - Parsing through the text file and separating contents using the delimiter '|'.
+        - Parsing through the text file and separating contents using the delimiter `|`.
         - Using parsed attributes to instantiate the Sales object for use in other command classes.
     - Implemented error handling during decoding: lines with missing delimiters or incorrect formatting in the text file are filtered out (collaboration with Cazh1).