diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md index 175bab3fe35..229f27ffbef 100644 --- a/docs/DeveloperGuide.md +++ b/docs/DeveloperGuide.md @@ -304,7 +304,7 @@ Given below is an example usage scenario and how the tag addition process behave Step 1: The user accesses the PatientSync application. -Step 2: The user executes the `addt 1 t/christian t/fall risk` command to add the tags `christian` and `fall risk` to patient 1 in the displayed patient list. The `AddTagsCommandParser` will be called to validate the input, ensuring that the index is valid and at least one tag is provided. Upon successful validation, it creates an `AddTagsCommand` instance. +Step 2: The user executes the `addt 1 t/christian` command to add the tag `christian` to patient 1 in the displayed patient list. The `AddTagsCommandParser` will be called to validate the input, ensuring that the index is valid and at least one tag is provided. Upon successful validation, it creates an `AddTagsCommand` instance. Note: Since multiple inputs are allowed, a set of tags are passed around, each of which is to be added if the above requirements are met. @@ -341,8 +341,7 @@ The following sequence diagram shows how the Add Tags operation works: * Pros: Simplifies data handling, avoids tag duplication. * Cons: Risk of losing previously assigned tags, less flexibility in tag management. --------------------------------------------------------------------------------------------------------------------- -
+

**Aspect: Logic handling for pre-existing tags** @@ -411,9 +410,6 @@ The following sequence diagram shows how the Delete Tags operation works: * Pros: Simplifies command execution, faster performance for small tag sets. * Cons: Requires multiple commands for each tag deletion, less flexible in bulk operations. --------------------------------------------------------------------------------------------------------------------- -
- **Aspect: Handling Missing Tags** * **Alternative 1 (current choice)**: Log output for non-existent tags to inform user, proceed with deleting the valid tags. @@ -424,6 +420,8 @@ The following sequence diagram shows how the Delete Tags operation works: * Pros: Ensures user awareness of non-existent tags, avoids accidental deletions, prompts users to provide valid tag inputs. * Cons: Requires users to fix the command before proceeding, potential interruption to workflow, may increase user frustration if multiple tags are missing. +

+ **Aspect: Feedback for Deletion Operation** * **Alternative 1 (current choice)**: Provide a success message for each tag successfully deleted. @@ -658,7 +656,6 @@ due to a limitation of PlantUML, the lifeline reaches the end of diagram. * Cons: User need to input the whole event name which might be tedious if `EVENT_NAME` is very long. -------------------------------------------------------------------------------------------------------------------- -
### 3.7 Editing an Event for a Patient diff --git a/docs/UserGuide.md b/docs/UserGuide.md index c05a376b2de..410abff5a99 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -256,7 +256,7 @@ Format: `addt INDEX t/TAG+` Note: -1. The addition of tags is cumulative. New tags will be added to the existing set of tags for the patient, preserving the previously assigned tags. +The addition of tags is cumulative. New tags will be added to the existing set of tags for the patient, preserving the previously assigned tags.