From 2af72b117c30b54d36c8fa34a9da4f17e046e689 Mon Sep 17 00:00:00 2001 From: NaychiMin Date: Tue, 14 Nov 2023 04:15:08 +0800 Subject: [PATCH] Update formatting of user guide and PPP --- docs/UserGuide.md | 5 +++-- docs/team/naychimin.md | 4 ++-- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 239a478caa..9472c25d4b 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -47,6 +47,7 @@ _/ _/ _/ _/ _/ _/ _/ _/ _/ ------------------------------------------------------------------------ > ``` + --------------------------------------------------- ## Summary @@ -229,6 +230,7 @@ Format: `list_ingredients index/DISH_INDEX` Example: - 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 @@ -259,7 +260,6 @@ Ingredient: chicken Qty: 500g Ingredient: milk Qty: 1000ml ``` - ### Viewing the total stock of ingredients : `view_stock` Displays the available stock of all the ingredients found in the pantry @@ -361,6 +361,7 @@ 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 index e0badb8127..e8b38115b7 100644 --- 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).