From 1f480b0db1f3d73823484eb2377d09ef1b5c4a60 Mon Sep 17 00:00:00 2001 From: Lin Shuang Shuang Date: Wed, 28 Feb 2024 20:01:42 +0800 Subject: [PATCH 1/2] Update UserGuide --- docs/UserGuide.md | 39 ++++++++++++++++++++------------------- 1 file changed, 20 insertions(+), 19 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 7abd1984218..c9fffcefa08 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -72,19 +72,19 @@ Shows a message explaning how to access the help page. Format: `help` -### Adding a person: `add` +### Adding a project: `add project` -Adds a person to the address book. +Adds a project to the project manager. -Format: `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]…​` - -
:bulb: **Tip:** -A person can have any number of tags (including 0) -
+Format: `add ` 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 CS2103T Duke Chatbot Project` +* `add CS2101 Presentation` + +Expected output: +* Success: ` has been added to the project list.` +* Failure: `Project already exists.` ### Listing all persons : `list` @@ -127,19 +127,20 @@ Examples: * `find alex david` returns `Alex Yeoh`, `David Li`
![result for 'find alex david'](images/findAlexDavidResult.png) -### Deleting a person : `delete` +### Deleting a project : `delete project` -Deletes the specified person from the address book. +Deletes the specified project from the project manager. -Format: `delete INDEX` +Format: `delete ` -* 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, …​ +* The specified project name must exist in the project manager. 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. +* `delete CS2101 Presentation` + +Expected output: +* Successful deletion: ` has been deleted from the project list.` +* Failed deletion: `Project not found: Please make sure the project exists.` ### Clearing all entries : `clear` @@ -189,9 +190,9 @@ _Details coming soon ..._ Action | Format, Examples --------|------------------ -**Add** | `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]…​`
e.g., `add n/James Ho p/22224444 e/jamesho@example.com a/123, Clementi Rd, 1234665 t/friend t/colleague` +**Add** | `add `
e.g., `add CS2101 Presentation` **Clear** | `clear` -**Delete** | `delete INDEX`
e.g., `delete 3` +**Delete** | `delete `
e.g., `delete CS2101 Presentation` **Edit** | `edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [t/TAG]…​`
e.g.,`edit 2 n/James Lee e/jameslee@example.com` **Find** | `find KEYWORD [MORE_KEYWORDS]`
e.g., `find James Jake` **List** | `list` From 4834d85179569a7700124185b3091c949390b625 Mon Sep 17 00:00:00 2001 From: Lin Shuang Shuang Date: Wed, 28 Feb 2024 20:55:30 +0800 Subject: [PATCH 2/2] Correct mistakes in command format --- docs/UserGuide.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index c9fffcefa08..7ff79a81e01 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -76,11 +76,11 @@ Format: `help` Adds a project to the project manager. -Format: `add ` +Format: `add project ` Examples: -* `add CS2103T Duke Chatbot Project` -* `add CS2101 Presentation` +* `add project CS2103T Duke Chatbot Project` +* `add project CS2101 Presentation` Expected output: * Success: ` has been added to the project list.` @@ -129,14 +129,14 @@ Examples: ### Deleting a project : `delete project` -Deletes the specified project from the project manager. +Deletes the specified project from the project list. -Format: `delete ` +Format: `delete project ` -* The specified project name must exist in the project manager. +* The specified project name must exist in the project list. Examples: -* `delete CS2101 Presentation` +* `delete project CS2101 Presentation` Expected output: * Successful deletion: ` has been deleted from the project list.` @@ -190,9 +190,9 @@ _Details coming soon ..._ Action | Format, Examples --------|------------------ -**Add** | `add `
e.g., `add CS2101 Presentation` +**Add** | `add project `
e.g., `add project CS2101 Presentation` **Clear** | `clear` -**Delete** | `delete `
e.g., `delete CS2101 Presentation` +**Delete** | `delete project `
e.g., `delete project CS2101 Presentation` **Edit** | `edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [t/TAG]…​`
e.g.,`edit 2 n/James Lee e/jameslee@example.com` **Find** | `find KEYWORD [MORE_KEYWORDS]`
e.g., `find James Jake` **List** | `list`