From bec3c730de3d15bb885eecbd6cdbbe40fae3ac19 Mon Sep 17 00:00:00 2001 From: Rishit02 Date: Sun, 24 Mar 2024 19:47:44 +0800 Subject: [PATCH 1/7] Update add command in UG --- docs/UserGuide.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 6a8830e3288..4da6d828f3f 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -99,15 +99,15 @@ ___ This command adds a new client to your client list. -Format: `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]… [k/NEXTOFKIN]` +Format: `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS k/NEXTOFKIN d/DESCRIPTION [t/TAG]…` -**Tip:** A person can have any number of tags (or even 0!) **Tip:** A person's next of kin field is optional (it can be ommitted if a person does not have a next of kin) +**Tip:** A person can have any number of tags (or even 0) Examples: -- `add n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01` -- `add n/Betsy Crowe t/friend e/betsycrowe@example.com a/Newgate Prison p/1234567 t/criminal` -- `add n/Bill James p/01232228943 e/billj@example.com a/12 College Avenue West t/high priority k/John Doe` +- `add n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01 d/Suffers from depression k/Jasmin Doe` +- `add n/Betsy Crowe t/friend d/Takes anxiety medication k/Bethany Crowe e/betsycrowe@example.com a/Newgate Prison p/1234567 t/criminal` +- `add n/Bill James p/01232228943 e/billj@example.com a/12 College Avenue West t/high priority k/John Doe d/Is an army veteran` ### Updating a client : `update` From dca2ced673c2878cad5d862015fbde0413ce6d44 Mon Sep 17 00:00:00 2001 From: Rishit02 Date: Sun, 24 Mar 2024 21:50:33 +0800 Subject: [PATCH 2/7] Update UG for update command --- docs/UserGuide.md | 27 ++++++++++++++------------- 1 file changed, 14 insertions(+), 13 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 4da6d828f3f..9e1eecdffe7 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -97,7 +97,7 @@ ___ ### Adding a new client: `add` -This command adds a new client to your client list. +This command adds a new client to your client list. All fields except the tag field are compulsory. Format: `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS k/NEXTOFKIN d/DESCRIPTION [t/TAG]…` @@ -113,11 +113,11 @@ Examples: This command helps update existing client's information in the client list in the event that something changes. -Format: `update u/existing user [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [t/TAG]…` +Format: `update u/existing user [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [d/DESCRIPTION] [k/NEXTOFKIN] [t/TAG]…` Examples: -- `Update u/Jane Doe n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-011` updates the information of Jane Doe's information to be +- `update u/Jane Doe n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-011` updates the information of Jane Doe's information to be name: John Doe Phone no: 98765432 email: [johnd@example.com](mailto:johnd@example.com) @@ -180,16 +180,17 @@ ___ ## Command summary -| Action | Format | Examples | -| --- | --- | --- | -| **Add** | `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]… [k/NEXTOFKIN]` |`add n/James Ho p/22224444 e/jamesho@example.com a/123, Clementi Rd, 1234665 t/friend t/colleague` | -| **Update** | `update u/existing user [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [t/TAG]…` | `Update u/Jane Doe n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-011` | -| **Find** | `find KEYWORD [MORE_KEYWORDS]` | `find James Jake` | -| **Undo** | `undo`| | -| **Redo** | `redo` | | -| **Display** | TBD | | -| **Clear** | `clear` | | -| **Exit** | `exit` | | +| Action | Format | Examples | +|-------------|-----------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------| +| **Add** | `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]… [k/NEXTOFKIN]` | `add n/James Ho p/22224444 e/jamesho@example.com a/123, Clementi Rd, 1234665 d/Suffers from anxiety k/Jon Ho t/friend t/colleague` | +| **Update** | `update u/existing user [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [t/TAG]…` | `Update u/Jane Doe n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-011` | +| **Find** | `find KEYWORD [MORE_KEYWORDS]` | `find James Jake` | +| **List** | `list` | | +| **Undo** | `undo` | | +| **Redo** | `redo` | | +| **Display** | TBD | | +| **Clear** | `clear` | | +| **Exit** | `exit` | | ___ From 3cfe9739fc38341bd00a35a44a8c785c4f76a4ba Mon Sep 17 00:00:00 2001 From: Rishit02 Date: Sun, 24 Mar 2024 22:38:34 +0800 Subject: [PATCH 3/7] Update UserGuide.md --- docs/UserGuide.md | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 9e1eecdffe7..0384ad33846 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -107,7 +107,14 @@ Examples: - `add n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01 d/Suffers from depression k/Jasmin Doe` - `add n/Betsy Crowe t/friend d/Takes anxiety medication k/Bethany Crowe e/betsycrowe@example.com a/Newgate Prison p/1234567 t/criminal` -- `add n/Bill James p/01232228943 e/billj@example.com a/12 College Avenue West t/high priority k/John Doe d/Is an army veteran` +- `add n/Aaron James p/01232228943 e/billj@example.com a/12 College Avenue West t/highPriority k/John Doe d/Is an army veteran` + +Usage of Add command + + ### Updating a client : `update` @@ -119,10 +126,17 @@ Examples: - `update u/Jane Doe n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-011` updates the information of Jane Doe's information to be name: John Doe - Phone no: 98765432 + phone no: 98765432 email: [johnd@example.com](mailto:johnd@example.com) address: John street, block 123, #01-011 +Usage of update command + + + ### Locating persons by name: `find` This command allows you to find a specific client in your client list by their **name** From 420fc2e4b030203442944b22290b95e75fcdd9d6 Mon Sep 17 00:00:00 2001 From: Rishit02 Date: Mon, 25 Mar 2024 11:05:23 +0800 Subject: [PATCH 4/7] Update UserGuide.md --- docs/UserGuide.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 0384ad33846..cbfc52ebf64 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -97,11 +97,16 @@ ___ ### Adding a new client: `add` -This command adds a new client to your client list. All fields except the tag field are compulsory. +This command adds a new client to your client list. Format: `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS k/NEXTOFKIN d/DESCRIPTION [t/TAG]…` +- Name being added must be unique +- All parameters _except tag_ are compulsory + + **Tip:** A person can have any number of tags (or even 0) + Examples: @@ -116,6 +121,11 @@ Usage of Add command Your browser does not support the video tag. +### Listing all persons : `list` +Shows a list of all persons. + +Format: `list` + ### Updating a client : `update` This command helps update existing client's information in the client list in the event that something changes. @@ -134,7 +144,7 @@ Usage of update command ### Locating persons by name: `find` From a641218729e5cef4c9bd79521ba82a79a93af457 Mon Sep 17 00:00:00 2001 From: Rishit02 Date: Mon, 25 Mar 2024 11:08:24 +0800 Subject: [PATCH 5/7] Update UG --- docs/UserGuide.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index d19c5d08b01..a3f22c7ad92 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -135,6 +135,12 @@ This command helps update existing client's information in the client list in th Format: `update u/existing user [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [d/DESCRIPTION] [k/NEXTOFKIN] [t/TAG]…` +- Edits the person with the specified NAME. The NAME provided must be the full name of the person. The NAME must be free to typos. +- At least one of the optional fields must be provided. +- Existing values will be updated to the input values. +- When editing tags, the existing tags of the person will be removed i.e adding of tags is not cumulative. +- You can remove all the person’s tags by typing t/ without specifying any tags after it. + Examples: - `update u/Jane Doe n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-011` updates the information of Jane Doe's information to be @@ -218,7 +224,6 @@ _These are a list of helpful actions to facilitate the ease of use of our applic - **Tip:** These shortcuts only work when the text box is selected From 1c74e387e371588706cd163c7764eb5a650aa172 Mon Sep 17 00:00:00 2001 From: Rishit02 Date: Mon, 25 Mar 2024 11:09:59 +0800 Subject: [PATCH 6/7] Update User Guide --- docs/UserGuide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index a3f22c7ad92..c097052c616 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -135,7 +135,7 @@ This command helps update existing client's information in the client list in th Format: `update u/existing user [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [d/DESCRIPTION] [k/NEXTOFKIN] [t/TAG]…` -- Edits the person with the specified NAME. The NAME provided must be the full name of the person. The NAME must be free to typos. +- Edits the person with the specified NAME. The NAME provided must be the full name of the person. The NAME must be free of typos. - At least one of the optional fields must be provided. - Existing values will be updated to the input values. - When editing tags, the existing tags of the person will be removed i.e adding of tags is not cumulative. From 31b429df95b4ff3d1ed85e32c08be02d50f4e82e Mon Sep 17 00:00:00 2001 From: Rishit02 Date: Mon, 25 Mar 2024 12:14:12 +0800 Subject: [PATCH 7/7] Update user guide --- docs/UserGuide.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index c097052c616..81abdb54d30 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -100,7 +100,7 @@ ___ ### Adding a new client: `add` -This command adds a new client to your client list. +_This command adds a new client to your client list._ Format: `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS k/NEXTOFKIN d/DESCRIPTION [t/TAG]…` @@ -131,7 +131,7 @@ Format: `list` ### Updating a client : `update` -This command helps update existing client's information in the client list in the event that something changes. +_This command helps update existing client's information in the client list in the event that something changes._ Format: `update u/existing user [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [d/DESCRIPTION] [k/NEXTOFKIN] [t/TAG]…`