Skip to content

Commit

Permalink
Update formatting of user guide and PPP
Browse files Browse the repository at this point in the history
  • Loading branch information
NaychiMin committed Nov 13, 2023
1 parent b78cee5 commit 2af72b1
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 4 deletions.
5 changes: 3 additions & 2 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ _/ _/ _/ _/ _/ _/ _/ _/ _/
------------------------------------------------------------------------
>
```

---------------------------------------------------
<!---@@author ziyi105--->
## Summary
Expand Down Expand Up @@ -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 |
Expand All @@ -241,7 +243,6 @@ Example:
+-------------------------------------------------------+
```


### Buying an ingredient : `buy_ingredient`
Adds one or more ingredients to the pantry

Expand All @@ -259,7 +260,6 @@ Ingredient: chicken Qty: 500g
Ingredient: milk Qty: 1000ml
```


<!---@@author ShaniceTang--->
### Viewing the total stock of ingredients : `view_stock`
Displays the available stock of all the ingredients found in the pantry
Expand Down Expand Up @@ -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: |
Expand Down
4 changes: 2 additions & 2 deletions docs/team/naychimin.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down

0 comments on commit 2af72b1

Please sign in to comment.