diff --git a/docs/_dg/InstructionsForManualTesting.md b/docs/_dg/InstructionsForManualTesting.md index cc194bb81d6..37a9d176f19 100644 --- a/docs/_dg/InstructionsForManualTesting.md +++ b/docs/_dg/InstructionsForManualTesting.md @@ -29,9 +29,9 @@ Prerequisite: There is at least 1 item in the Item List Box. ### Tags #### Creating a Tag -Test Case: `newtag n/Fruits`
Expected Output in Command Output Box: New tag added and its details. +1. Test Case: `newtag n/Fruits`
Expected Output in Command Output Box: New tag added and its details. -Test Case: `newtag n/!`
Expected Output in Command Output Box: Error message for invalid name format. +1. Test Case: `newtag n/!`
Expected Output in Command Output Box: Error message for invalid name format. #### Renaming a Tag Prerequisite: Original tag to be renamed exists. @@ -72,4 +72,4 @@ Prerequisite: Tag currently exists in FoodRem ### Exit -Test Case: `exit`
Expected Output: FoodRem application closes. +1. Test Case: `exit`
Expected Output: FoodRem application closes. diff --git a/docs/_dg/ModelComponent.md b/docs/_dg/ModelComponent.md index e8b8c93653c..4ca8c0950af 100644 --- a/docs/_dg/ModelComponent.md +++ b/docs/_dg/ModelComponent.md @@ -5,7 +5,7 @@ The `Model` component, -* stores the food rem data i.e., all `Item` and `Tag` objects (which are contained in the respective `UniqueItemList` and `UniqueTagList` objects). +* stores FoodRem data i.e., all `Item` and `Tag` objects (which are contained in the respective `UniqueItemList` and `UniqueTagList` objects). * stores the currently 'selected' `Item` and `Tag` objects (e.g., results of a search query) as a separate _filtered_ list which is exposed to outsiders as unmodifiable `ObservableList` and `ObservableList` that can be 'observed' e.g. the UI can be bound to this list so that the UI automatically updates when the data in the list change. * stores a `UserPref` object that represents the user’s preferences. This is exposed to the outside as a `ReadOnlyUserPref` objects. * does not depend on any of the other three components (as the `Model` represents data entities of the domain, they should make sense on their own without depending on other components) diff --git a/docs/_dg/UseCases.md b/docs/_dg/UseCases.md index 79325f4f60b..f8de5b2f20d 100644 --- a/docs/_dg/UseCases.md +++ b/docs/_dg/UseCases.md @@ -9,6 +9,8 @@ MSS: 1. User adds a new Item to the inventory with the specified arguments. 1. FoodRem informs user that item has been successfully created. +Use case ends. + Extensions: * 1a. If the item name already exists in the inventory, FoodRem will throw an error. @@ -35,6 +37,9 @@ MSS: 1. User enters the command to edit the item with new fields. 1. FoodRem informs user that item has been successfully edited. +Use case ends. + + Extensions: * 3a. If the item name does not exist in the inventory, FoodRem will throw an error. @@ -61,6 +66,8 @@ MSS: 1. User enters the command to delete an item. 1. FoodRem informs user that item has been successfully deleted. +Use case ends. + Extensions: * 3b. FoodRem detects that there is an issue with the command entered. @@ -79,6 +86,8 @@ MSS: 1. User adds a new Tag to the inventory with the specified arguments. 1. FoodRem informs user that tag has been successfully created. +Use case ends. + Extensions: * 3a. If the tag name already exists in the inventory, FoodRem will throw an error. @@ -102,6 +111,7 @@ MSS: 1. FoodRem shows a list containing the items. 1. User searches for an Item with one or more criteria. 1. FoodRem displays all items in inventory which matches the given criteria. + Use case ends. * 3a. FoodRem detects that there is an issue with the command entered.