From 0c9123698e58f72543aaef7493b8663e6808e75e Mon Sep 17 00:00:00 2001 From: ForAeons Date: Sun, 7 Apr 2024 11:10:39 +0800 Subject: [PATCH 1/5] Update user guide and make find command docs consistent --- docs/UserGuide.md | 48 ++++++++++++++++++++++++----------------------- 1 file changed, 25 insertions(+), 23 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index a643163567a..01952a2fff7 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -43,7 +43,7 @@ The latest version is compatible with older versions. A GUI similar to the below image should appear in a few seconds. Note how the app contains some sample data. -Main Window UI on first launch +Main Window UI on first launch
@@ -56,7 +56,7 @@ A GUI similar to the below image should appear in a few seconds. Note how the ap * `list` : Lists all contacts. -* `addstu nn/e0952224 n/John Doe p/98765432 e/johnd@example.com m/Computer Science` : Adds a student named `John Doe` to the contact book. +* `addstu nn/e0952224 n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01` : Adds a student named `John Doe` to the contact book. * `delstu nn/NUSNET_ID` : Deletes the student with the specified `NUSNET_ID` from the contact book. @@ -142,6 +142,7 @@ Format: `help` A new window is opened, so that it does not clutter up your main window. A GUI similar to the below image should appear. +[//]: # (TODO: update this image once the help window is finalized in v1.4) Help Window UI @@ -195,7 +196,7 @@ Course code should follow the format "XX1234Y", Y is optional. ### Adding a student: `addstu` Adds a student to the contact book. -Format: `addstu n/NAME nn/NUSNET [p/PHONE] [e/EMAIL] [m/MAJOR] [t/TAG]…​` +Format: `addstu n/NAME p/PHONE_NUMBER e/EMAIL nn/NUSNET_ID a/ADDRESS [t/TAG]…​` * Add a student with the given details. * The name and nusnet id must be provided. And nusnet id must be unique. @@ -207,8 +208,8 @@ Format: `addstu n/NAME nn/NUSNET [p/PHONE] [e/EMAIL] [m/MAJOR] [t/TAG]…​` Examples: -* `addstu n/John Doe nn/e1234567 p/98765432 e/johnd@example.com m/Computer Science` -* `addstu n/Betsy Crowe nn/e01234567 t/friend e/betsycrowe@example.com m/Mathematics p/1234567 t/club` +* `addstu n/John Doe nn/e1234567 p/98765432 e/johnd@example.com a/John street, block 123, #01-01` +* `addstu n/Betsy Crowe nn/e01234567 t/friend e/betsycrowe@example.com a/Newgate Prison p/1234567 t/criminal` * `addstu n/Betsy Crowe nn/e01234567` --- @@ -231,7 +232,7 @@ If there are additional arguments behind `list` we will simply ignore them. Edits an existing person in the contact book. -Format: `edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [m/MAJOR] [nn/NUSNET_ID] [t/TAG]…​` +Format: `edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [nn/NUSNET_ID] [t/TAG]…​` * 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. @@ -314,6 +315,7 @@ Format: `find KEYWORD [MORE_KEYWORDS]` #g#Example:## `find alex david` returns `Alex Yeoh`, `David Li`, as seen in the image below. +[//]: # (TODO: update this image) result for 'find alex david @@ -351,15 +353,15 @@ Example: Deletes the specified student from the contact book. -Format: `delstu nn/NUSNET_ID` +Format: `delstu NUSNET_ID` -* Deletes the student with the specified NUSNet ID from the contact book. +* Deletes the student with the specified NUSNET_ID from the contact book. Examples: -* `delstu nn/E0957499` deletes the student with the NUSNet ID of `E0957499` in the contact book. +* `delstu e0957499` deletes the student with the NUSNET_ID of `e0957499` in the contact book. Pro Tip: -* If you cannot remember your student's NUSNet ID, you could use `find Betsy` or `list` followed by `delstu nn/` to find and delete the student. +* If you cannot remember your student's NUSNET_ID, you could use `find Betsy` or `list` followed by `delstu ` to find and delete the student. ---
@@ -515,16 +517,16 @@ If you move the application to a secondary screen, and later switch to using onl ## Command summary -| Action | Format, Examples | -|--------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **Add Student** | `addstu n/NAME p/PHONE_NUMBER e/EMAIL nn/NUSNET_ID m/MAJOR [t/TAG]…​`
e.g., `add n/James Ho p/22224444 e/jamesho@example.com nn/e1234567 m/Computer Science t/friend t/colleague` | -| **Clear** | `clear` | -| **Delete Student** | `delstu nn/NUSNET_ID`
e.g., `delstu nn/e0957499` | -| **Edit** | `edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [m/MAJOR] [t/TAG]…​`
e.g.,`edit 2 n/James Lee e/jameslee@example.com` | -| **Mark** | `mark nn/NUSNET_ID wk/WEEK_NUMBER`
e.g., `mark nn/e1234567 wk/3` | -| **Unmark** | `unmark nn/NUSNET_ID wk/WEEK_NUMBER`
e.g., `unmark nn/e1234567 wk/3` | -| **Find** | `find KEYWORD [MORE_KEYWORDS]`
e.g., `find James Jake` | -| **Set Course** | `setcrs COURSE_NAME` | -| **List** | `list` | -| **Help** | `help` | -| **Exit** | `exit` | +| Action | Format, Examples | +|--------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **Add Student** | `addstu n/NAME p/PHONE_NUMBER e/EMAIL nn/NUSNET_ID a/ADDRESS [t/TAG]…​`
e.g., `add n/James Ho p/22224444 e/jamesho@example.com nn/e1234567 a/123, Clementi Rd, 1234665 t/friend t/colleague` | +| **Clear** | `clear` | +| **Delete Student** | `delstu nn/NUSNET_ID`
e.g., `delstu nn/e0957499` | +| **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` | +| **Mark** | `mark nn/NUSNET_ID wk/WEEK_NUMBER`
e.g., `mark nn/e1234567 wk/3` | +| **Unmark** | `unmark nn/NUSNET_ID wk/WEEK_NUMBER`
e.g., `unmark nn/e1234567 wk/3` | +| **Find** | `find KEYWORD [KEYWORD]…​`
e.g., `find James Jake` | +| **Set Course** | `setcrs COURSE_NAME` | +| **List** | `list` | +| **Help** | `help` | +| **Exit** | `exit` | From 89c89928babfa977da76775075c1d2758d0284de Mon Sep 17 00:00:00 2001 From: ForAeons Date: Sun, 7 Apr 2024 14:50:26 +0800 Subject: [PATCH 2/5] Revert change to find commant parameter, add explanation to user guide --- docs/UserGuide.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 01952a2fff7..a5c04433615 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -257,8 +257,16 @@ This command differs from most other commands that use the `NUSNET_ID` to identi Finds students whose names contain any of the given keywords. -Format: `find KEYWORD [MORE_KEYWORDS]` +Format: `find KEYWORD [MORE_KEYWORDS]…​` + + +**Parameters of find command:** + +- `KEYWORD` is the first keyword to search for. This is a compulsory parameter. +- `[MORE_KEYWORDS]` are additional, optional keywords to search for. You can have any number of additional keywords. + + From b99d53444986f2699250378831ff48e7986e4c68 Mon Sep 17 00:00:00 2001 From: Wu Xiaoyun Date: Mon, 8 Apr 2024 07:56:48 +0800 Subject: [PATCH 3/5] Update docs/UserGuide.md formating Co-authored-by: Titus Chew <39845485+tituschewxj@users.noreply.github.com> --- docs/UserGuide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index a5c04433615..2f1403b2b7f 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -261,7 +261,7 @@ Format: `find KEYWORD [MORE_KEYWORDS]…​` -**Parameters of find command:** +**Parameters of `find` command:** - `KEYWORD` is the first keyword to search for. This is a compulsory parameter. - `[MORE_KEYWORDS]` are additional, optional keywords to search for. You can have any number of additional keywords. From becaeda1e5d274d49520ff30791d77e5c89b38a9 Mon Sep 17 00:00:00 2001 From: ForAeons Date: Mon, 8 Apr 2024 07:59:10 +0800 Subject: [PATCH 4/5] Add ... to keyword explanation --- docs/UserGuide.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 2f1403b2b7f..6bb6f1aaeb7 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -264,13 +264,13 @@ Format: `find KEYWORD [MORE_KEYWORDS]…​` **Parameters of `find` command:** - `KEYWORD` is the first keyword to search for. This is a compulsory parameter. -- `[MORE_KEYWORDS]` are additional, optional keywords to search for. You can have any number of additional keywords. +- `[MORE_KEYWORDS]…​` are additional, optional keywords to search for. You can have any number of additional keywords. -**About the find command:** +**About the `find` command:** From 92ef0bffc1b5a006c4791f47e827ee7b54783aaa Mon Sep 17 00:00:00 2001 From: ForAeons Date: Mon, 8 Apr 2024 14:12:14 +0800 Subject: [PATCH 5/5] Rebase master --- docs/UserGuide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 6bb6f1aaeb7..4a0c7aed077 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -533,7 +533,7 @@ If you move the application to a secondary screen, and later switch to using onl | **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` | | **Mark** | `mark nn/NUSNET_ID wk/WEEK_NUMBER`
e.g., `mark nn/e1234567 wk/3` | | **Unmark** | `unmark nn/NUSNET_ID wk/WEEK_NUMBER`
e.g., `unmark nn/e1234567 wk/3` | -| **Find** | `find KEYWORD [KEYWORD]…​`
e.g., `find James Jake` | +| **Find** | `find KEYWORD [MORE_KEYWORDS]…​`
e.g., `find James Jake` | | **Set Course** | `setcrs COURSE_NAME` | | **List** | `list` | | **Help** | `help` |