From e5845ede624d545df1b1c7c39d58729203157f02 Mon Sep 17 00:00:00 2001 From: Ikhoon Date: Thu, 29 Feb 2024 00:10:05 +0800 Subject: [PATCH 1/7] User-guide Updated --- docs/UserGuide.md | 68 ++++++++++++++++++++++++++++++++--------------- 1 file changed, 47 insertions(+), 21 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 7abd1984218..22de1aca4a7 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -92,22 +92,40 @@ Shows a list of all persons in the address book. Format: `list` -### Editing a person : `edit` +### Edit Candidate Details: `edit` -Edits an existing person in the address book. +In this section, we will learn about how to edit an existing candidate in the database with command format and examples. -Format: `edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [t/TAG]…​` +#### 1. How to use the `edit` command? -* Edits the person at the specified `INDEX`. The index refers to the index number shown in the displayed person list. The index **must be a positive integer** 1, 2, 3, …​ -* 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. +You can edit any of the valid candidate details including name, email, country and tags at the specified **INDEX**. Here, **INDEX** refers to the index number of candidates shown in the displayed candidate list. + +Here is a valid format of `edit` command: +`edit INDEX [n/NAME] [e/EMAIL] [c/COUNTRY] [p/PHONE] [t/TAG1] [t/TAG2]...` + +--- + +> [!NOTE] +> 1. Even though you can edit multiple candidate details at once, attribute to edit must be **non-empty**. In other words, you must edit **at least one attribute** specified above. +> 2. When **editing tags**, the existing tags of the candidate will be **removed**. Thus, you must specify **every tag** you want to keep on the candidate whenever you edit the candidate details. + +> [!WARNING] +> **Comment** field for the candidates **cannot be edited** by `edit` as there is a dedicated method for editing comments separately. + +#### 2. Example usages of`edit` commands + +*Example 1* : `edit 24 n/Johnny Doe e/[johnnydoe@gmail.com](mailto:johnnydoe@gmail.com) c/Singapore` + +This command edits **name**, **email**, and **country of residence** of the candidate with index 24 to **Johnny Doe**, [johnnydoe@gmail.com](mailto:johnnydoe@gmail.com), and **Singapore**, respectively. + +--- + +*Example 2* : `edit 8 n/Jeb Song e/[jebsong@gmail.com](mailto:jebsong@gmail.com) t/Accepted` + +This command edits **name**, **email**, and the tag for **acceptance status** of the candidate with index 8 to **Jeb Song**, [jebsong@gmail.com](mailto:jebsong@gmail.com), and **Accepted**, respectively. Note that existing tag on this candidate is completely removed and new tag `accepted` if added. + +If edit candidate command is successfully executed, the app will display the edited candidate with the edited attributes. -Examples: -* `edit 1 p/91234567 e/johndoe@example.com` Edits the phone number and email address of the 1st person to be `91234567` and `johndoe@example.com` respectively. -* `edit 2 n/Betsy Crower t/` Edits the name of the 2nd person to be `Betsy Crower` and clears all existing tags. ### Locating persons by name: `find` @@ -127,19 +145,27 @@ Examples: * `find alex david` returns `Alex Yeoh`, `David Li`
![result for 'find alex david'](images/findAlexDavidResult.png) -### Deleting a person : `delete` +### Delete Candidate: `delete` -Deletes the specified person from the address book. +In this section, we will learn about how to delete existing candidates in the database with command format and examples. -Format: `delete INDEX` +#### 1. How to use the `delete` command? -* Deletes the person at the specified `INDEX`. -* The index refers to the index number shown in the displayed person list. -* The index **must be a positive integer** 1, 2, 3, …​ +You can delete any of candidate in the displayed list at the specified **INDEX**. Here, **INDEX** refers to the index number of candidates shown in the displayed candidate list. The candidate index **must be** within the range from **1 to *n***, where ***n*** represents the **number of candidates** in the database. -Examples: -* `list` followed by `delete 2` deletes the 2nd person in the address book. -* `find Betsy` followed by `delete 1` deletes the 1st person in the results of the `find` command. +Here is a valid format of `delete` command: + +`delete INDEX` + +--- +> [!NOTE] +> If INDEX number provided is valid, a confirmation message would be displayed where the user would type **y/n** to confirm the deletion upon the successful execution of the command. If ***y*** is selected for the deletion, it will delete the candidate from the list and display the deleted candidate with attributes. If ***n*** is selected for the deletion, it will display that the delete operation is cancelled. + +#### 2. Example usage of`delete` commands + +*Example* : `delete 3` + +This command removes the candidate at third position in the candidate list displayed and returns you with the updated candidate list. ### Clearing all entries : `clear` From f9ff45679b888d2b2da3d546769789e210717227 Mon Sep 17 00:00:00 2001 From: Ikhoon Date: Thu, 29 Feb 2024 00:24:38 +0800 Subject: [PATCH 2/7] User guide text style fixed --- docs/UserGuide.md | 15 ++++++--------- 1 file changed, 6 insertions(+), 9 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 22de1aca4a7..6c13f5f2aad 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -94,9 +94,7 @@ Format: `list` ### Edit Candidate Details: `edit` -In this section, we will learn about how to edit an existing candidate in the database with command format and examples. - -#### 1. How to use the `edit` command? +Edits an existing candidate in the database with command format and examples. You can edit any of the valid candidate details including name, email, country and tags at the specified **INDEX**. Here, **INDEX** refers to the index number of candidates shown in the displayed candidate list. @@ -112,18 +110,19 @@ Here is a valid format of `edit` command: > [!WARNING] > **Comment** field for the candidates **cannot be edited** by `edit` as there is a dedicated method for editing comments separately. -#### 2. Example usages of`edit` commands +--- *Example 1* : `edit 24 n/Johnny Doe e/[johnnydoe@gmail.com](mailto:johnnydoe@gmail.com) c/Singapore` This command edits **name**, **email**, and **country of residence** of the candidate with index 24 to **Johnny Doe**, [johnnydoe@gmail.com](mailto:johnnydoe@gmail.com), and **Singapore**, respectively. ---- *Example 2* : `edit 8 n/Jeb Song e/[jebsong@gmail.com](mailto:jebsong@gmail.com) t/Accepted` This command edits **name**, **email**, and the tag for **acceptance status** of the candidate with index 8 to **Jeb Song**, [jebsong@gmail.com](mailto:jebsong@gmail.com), and **Accepted**, respectively. Note that existing tag on this candidate is completely removed and new tag `accepted` if added. +--- + If edit candidate command is successfully executed, the app will display the edited candidate with the edited attributes. @@ -147,9 +146,7 @@ Examples: ### Delete Candidate: `delete` -In this section, we will learn about how to delete existing candidates in the database with command format and examples. - -#### 1. How to use the `delete` command? +Delete existing candidates in the database with command format and examples. You can delete any of candidate in the displayed list at the specified **INDEX**. Here, **INDEX** refers to the index number of candidates shown in the displayed candidate list. The candidate index **must be** within the range from **1 to *n***, where ***n*** represents the **number of candidates** in the database. @@ -161,7 +158,7 @@ Here is a valid format of `delete` command: > [!NOTE] > If INDEX number provided is valid, a confirmation message would be displayed where the user would type **y/n** to confirm the deletion upon the successful execution of the command. If ***y*** is selected for the deletion, it will delete the candidate from the list and display the deleted candidate with attributes. If ***n*** is selected for the deletion, it will display that the delete operation is cancelled. -#### 2. Example usage of`delete` commands +--- *Example* : `delete 3` From 7f3bbf13edf9658fa9e35033f50c74d2095439b9 Mon Sep 17 00:00:00 2001 From: Ikhoon Date: Thu, 29 Feb 2024 00:30:55 +0800 Subject: [PATCH 3/7] User guide format re-updated --- docs/UserGuide.md | 11 ++++------- 1 file changed, 4 insertions(+), 7 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 6c13f5f2aad..86b74e005ac 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -94,12 +94,11 @@ Format: `list` ### Edit Candidate Details: `edit` -Edits an existing candidate in the database with command format and examples. +Edits an existing candidate in the database. You can edit any of the valid candidate details including name, email, country and tags at the specified **INDEX**. Here, **INDEX** refers to the index number of candidates shown in the displayed candidate list. -Here is a valid format of `edit` command: -`edit INDEX [n/NAME] [e/EMAIL] [c/COUNTRY] [p/PHONE] [t/TAG1] [t/TAG2]...` +Format: `edit INDEX [n/NAME] [e/EMAIL] [c/COUNTRY] [p/PHONE] [t/TAG1] [t/TAG2]…​` --- @@ -146,13 +145,11 @@ Examples: ### Delete Candidate: `delete` -Delete existing candidates in the database with command format and examples. +Delete existing candidates in the database. You can delete any of candidate in the displayed list at the specified **INDEX**. Here, **INDEX** refers to the index number of candidates shown in the displayed candidate list. The candidate index **must be** within the range from **1 to *n***, where ***n*** represents the **number of candidates** in the database. -Here is a valid format of `delete` command: - -`delete INDEX` +Format: `delete INDEX` --- > [!NOTE] From 4741a8c2062e047a8561edbba3aa86f2ee39b58a Mon Sep 17 00:00:00 2001 From: Ikhoon Date: Thu, 29 Feb 2024 00:39:00 +0800 Subject: [PATCH 4/7] User guide again updated --- docs/UserGuide.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 86b74e005ac..46abf5fb4be 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -92,13 +92,13 @@ Shows a list of all persons in the address book. Format: `list` -### Edit Candidate Details: `edit` +### Edit candidate details: `edit` Edits an existing candidate in the database. You can edit any of the valid candidate details including name, email, country and tags at the specified **INDEX**. Here, **INDEX** refers to the index number of candidates shown in the displayed candidate list. -Format: `edit INDEX [n/NAME] [e/EMAIL] [c/COUNTRY] [p/PHONE] [t/TAG1] [t/TAG2]…​` +Format: `edit INDEX [n/NAME] [e/EMAIL] [c/COUNTRY] [p/PHONE] [t/TAG]…​` --- @@ -107,22 +107,22 @@ Format: `edit INDEX [n/NAME] [e/EMAIL] [c/COUNTRY] [p/PHONE] [t/TAG1] [t/TAG2] > 2. When **editing tags**, the existing tags of the candidate will be **removed**. Thus, you must specify **every tag** you want to keep on the candidate whenever you edit the candidate details. > [!WARNING] -> **Comment** field for the candidates **cannot be edited** by `edit` as there is a dedicated method for editing comments separately. +> **Comment and Interview Status** field for the candidates **cannot be edited** by `edit` as there is a dedicated method for editing them separately. --- -*Example 1* : `edit 24 n/Johnny Doe e/[johnnydoe@gmail.com](mailto:johnnydoe@gmail.com) c/Singapore` +*Example 1* : `edit 24 n/Johnny Doe e/johnnydoe@gmail.com c/Singapore` -This command edits **name**, **email**, and **country of residence** of the candidate with index 24 to **Johnny Doe**, [johnnydoe@gmail.com](mailto:johnnydoe@gmail.com), and **Singapore**, respectively. +This command edits **name**, **email**, and **country of residence** of the candidate with index 24 to **Johnny Doe**, **johnnydoe@gmail.com**, and **Singapore**, respectively. -*Example 2* : `edit 8 n/Jeb Song e/[jebsong@gmail.com](mailto:jebsong@gmail.com) t/Accepted` +*Example 2* : `edit 8 n/Jeb Song e/jebsong@gmail.com t/IMO Gold` -This command edits **name**, **email**, and the tag for **acceptance status** of the candidate with index 8 to **Jeb Song**, [jebsong@gmail.com](mailto:jebsong@gmail.com), and **Accepted**, respectively. Note that existing tag on this candidate is completely removed and new tag `accepted` if added. +This command edits **name**, **email**, and the tag for **acceptance status** of the candidate with index 8 to **Jeb Song**, **jebsong@gmail.com**, and **IMO Gold**, respectively. Note that existing tag on this candidate is completely removed and new tag `IMO Gold` is added. --- -If edit candidate command is successfully executed, the app will display the edited candidate with the edited attributes. +If edit command is successfully executed, the app will display the edited candidate with the edited attributes. ### Locating persons by name: `find` @@ -143,7 +143,7 @@ Examples: * `find alex david` returns `Alex Yeoh`, `David Li`
![result for 'find alex david'](images/findAlexDavidResult.png) -### Delete Candidate: `delete` +### Delete a candidate: `delete` Delete existing candidates in the database. From e3f10bcf9d2d4769d6d771af0d6e0bfdcb93e380 Mon Sep 17 00:00:00 2001 From: Ikhoon Date: Thu, 29 Feb 2024 00:40:13 +0800 Subject: [PATCH 5/7] Text fixed --- docs/UserGuide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 46abf5fb4be..2f8fc53237d 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -122,7 +122,7 @@ This command edits **name**, **email**, and the tag for **acceptance status** of --- -If edit command is successfully executed, the app will display the edited candidate with the edited attributes. +If edit command is successfully executed, the app will display the edited candidate with the new attributes. ### Locating persons by name: `find` From c657f2755ef960127735aef72122031306a68347 Mon Sep 17 00:00:00 2001 From: Ikhoon Date: Thu, 29 Feb 2024 00:47:06 +0800 Subject: [PATCH 6/7] User guide updated again --- docs/UserGuide.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 2f8fc53237d..7e093bbdb1a 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -74,7 +74,7 @@ Format: `help` ### Adding a person: `add` -Adds a person to the address book. +Adds a person to the candidate list. Format: `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]…​` @@ -94,7 +94,7 @@ Format: `list` ### Edit candidate details: `edit` -Edits an existing candidate in the database. +Edits an existing candidate in the list. You can edit any of the valid candidate details including name, email, country and tags at the specified **INDEX**. Here, **INDEX** refers to the index number of candidates shown in the displayed candidate list. @@ -145,15 +145,15 @@ Examples: ### Delete a candidate: `delete` -Delete existing candidates in the database. +Deletes an existing candidate from the list. -You can delete any of candidate in the displayed list at the specified **INDEX**. Here, **INDEX** refers to the index number of candidates shown in the displayed candidate list. The candidate index **must be** within the range from **1 to *n***, where ***n*** represents the **number of candidates** in the database. +You can delete any candidates in the displayed list at the specified **INDEX**. Here, **INDEX** refers to the index number of candidates shown in the displayed candidate list. The candidate index **must be** within the range from ***1*** to ***n***, where ***n*** represents the **number of candidates** in the database. Format: `delete INDEX` --- > [!NOTE] -> If INDEX number provided is valid, a confirmation message would be displayed where the user would type **y/n** to confirm the deletion upon the successful execution of the command. If ***y*** is selected for the deletion, it will delete the candidate from the list and display the deleted candidate with attributes. If ***n*** is selected for the deletion, it will display that the delete operation is cancelled. +> If INDEX provided is valid, a confirmation message would be displayed where the user would type **y/n** to confirm the deletion. If ***y*** is selected, it will delete the candidate from the list and display the deleted candidate. If ***n*** is selected, it will display that the delete operation is cancelled. --- From 34161802b7c034c6d86abc660793e40909582fdc Mon Sep 17 00:00:00 2001 From: Ikhoon Date: Thu, 29 Feb 2024 00:48:12 +0800 Subject: [PATCH 7/7] User guide finalized --- docs/UserGuide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 7e093bbdb1a..6b19aaa01ea 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -159,7 +159,7 @@ Format: `delete INDEX` *Example* : `delete 3` -This command removes the candidate at third position in the candidate list displayed and returns you with the updated candidate list. +This command removes the candidate at third position in the candidate list displayed. ### Clearing all entries : `clear`