Skip to content

Commit

Permalink
Merge pull request #226 from prawnzyy/master
Browse files Browse the repository at this point in the history
Update documentation
  • Loading branch information
dhruvir29 authored Nov 14, 2023
2 parents cb8ea89 + fab3d31 commit 7590fc5
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 0 deletions.
22 changes: 22 additions & 0 deletions docs/DeveloperGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -206,6 +206,8 @@ Step 10. A `RecipeAddCommand` instance is created by the `RecipeAddCommandParser

Step 9. The `RecipeAddCommand` adds the new `Recipe` instance to the recipe list in `ModelManager`.

<div style="page-break-after: always;"></div>

The following sequence diagram shows how the add recipe operation works:
![img.png](img.png)

Expand Down Expand Up @@ -586,6 +588,26 @@ Priorities: High (must have) - `***`, Medium (nice to have) - `**`, Low (unlikel
- 2c. There are currently no recipes stored
- No updates will be made to the screen

#### Use case: Add a new recipe
#### MSS
1. User requests to start adding a recipe
2. User enters the name of the recipe
3. User enters the ingredients of the recipe
4. User enters command to move to the steps portion
5. User enters the steps of the recipe
6. User enters command to finalise the add recipe command
7. [Ba]king [Br]ead adds the recipe to the recipe list

Use case ends

#### Extensions:
- 2a. Name is not of alphanumeric format
- [Ba]king [Br]ead shows an error message
- 3a. Ingredient inputted does not follow given format
- [Ba]king [Br]ead shows an error message
- 5a. Step inputted does not contain an index at the start
- [Ba]king [Br]ead shows an error message

#### Use case: Search for a recipe with a specific ingredient
#### MSS
1. User requests to search for recipes with a specific ingredient
Expand Down
3 changes: 3 additions & 0 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -230,6 +230,9 @@ complete recipe
* For the recipe steps, the format to follow is `(index). (step)` where an example is `1. Mix Water and Flour`.
* For the recipe steps, you have to remember the index of step you are typing in and check it by yourself.

**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.

Example:
```
addrecipe
Expand Down

0 comments on commit 7590fc5

Please sign in to comment.