From 0be8ce80617c8d5e9867e274b2b1daf62b6a0cc2 Mon Sep 17 00:00:00 2001 From: gnahzeus Date: Thu, 27 Oct 2022 21:48:30 +0800 Subject: [PATCH 1/6] Update table of contents --- docs/UserGuide.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index a8507922b45..c801d5c4fcb 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -28,9 +28,9 @@ For a full list of commands and detailed instructions, head to the [Features](#f * [Viewing all students: `list`](#viewing-all-students-list) * [Finding a student: `find`](#finding-a-student-find) * [Find by Name](#find-by-name) - * [Find by Email](#) - * [Find by Address](#) - * [Find by Student's Contact Number](#) + * [Find by Email](#find-by-email) + * [Find by Address](#find-by-address) + * [Find by Student's Contact Number](#find-by-students-contact-number) * [Find by Next of Kin's Contact Number](#find-by-next-of-kins-contact-number) * [Find by Class Date](#find-by-class-date) * [Find by Tag](#find-by-tag) From f478d0579dbda85ac97bb425e0c48cc0d732db98 Mon Sep 17 00:00:00 2001 From: gnahzeus Date: Thu, 27 Oct 2022 21:55:02 +0800 Subject: [PATCH 2/6] Add find by email in UG --- docs/UserGuide.md | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index c801d5c4fcb..294115c7cd5 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -415,6 +415,40 @@ Example: ![UiFindName](images/UG-screenshots/UiFindName.png) +#### Find by Email: + +Finds all students with a particular email. + +Formats: `find e/EMAIL + +- Only one email can be searched at each time. +- Full email must be used for corresponding student to be found. + +```yaml +❗Caution: + Do not include more than one email such as + find e/jonsnow@winterfell.com ghost@woods.com. +``` + +Examples: + +`find e/jonsnow@winterfell.com` returns all students with email set as `jonsnow@winterfell.com`. + +#### Find by Name: + +Finds all students with names matching the keywords. + +Format: `find n/KEYWORD [MORE_KEYWORDS]` + +- The search is case-insensitive. e.g., `alex` will match `Alex`. +- The order of the keywords does not matter. e.g. `Yeoh Alex` will match `Alex Yeoh`. +- Only full words will be matched e.g., `Han` will not match `Hans`. +- Students matching at least one keyword will be returned. e.g., `Hans Bo` will return `Hans Gruber`, `Bo Yang`. + +Example: + +`find n/tan` returns `Tan Xiao Ming` and `John Tan`. + #### Find by Student's Contact Number: Finds student with the matching contact number. From 7825a257b13031bd19f8f6be424bbe0e7878b89c Mon Sep 17 00:00:00 2001 From: gnahzeus Date: Thu, 27 Oct 2022 21:56:45 +0800 Subject: [PATCH 3/6] Add case insensitivity in email search --- docs/UserGuide.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 294115c7cd5..3dd99affd30 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -421,6 +421,7 @@ Finds all students with a particular email. Formats: `find e/EMAIL +- The search is case-insensitive. e.g., `ghost@woods.com` will match `ghOst@woOds.com`. - Only one email can be searched at each time. - Full email must be used for corresponding student to be found. @@ -434,11 +435,11 @@ Examples: `find e/jonsnow@winterfell.com` returns all students with email set as `jonsnow@winterfell.com`. -#### Find by Name: +#### Find by address: -Finds all students with names matching the keywords. +Finds all students with addresses matching the keywords. -Format: `find n/KEYWORD [MORE_KEYWORDS]` +Format: `find a/KEYWORD [MORE_KEYWORDS]` - The search is case-insensitive. e.g., `alex` will match `Alex`. - The order of the keywords does not matter. e.g. `Yeoh Alex` will match `Alex Yeoh`. From 9bf5aa9075cac57a11b65f4bb0aef57b0fadc1ff Mon Sep 17 00:00:00 2001 From: gnahzeus Date: Thu, 27 Oct 2022 21:59:20 +0800 Subject: [PATCH 4/6] Add example for partial email search in UG --- docs/UserGuide.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 3dd99affd30..68fc3a1c755 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -423,7 +423,7 @@ Formats: `find e/EMAIL - The search is case-insensitive. e.g., `ghost@woods.com` will match `ghOst@woOds.com`. - Only one email can be searched at each time. -- Full email must be used for corresponding student to be found. +- Full email must be used for corresponding student to be found e.g., `ghost` will not match `ghost@woods.com`. ```yaml ❗Caution: @@ -441,9 +441,8 @@ Finds all students with addresses matching the keywords. Format: `find a/KEYWORD [MORE_KEYWORDS]` -- The search is case-insensitive. e.g., `alex` will match `Alex`. -- The order of the keywords does not matter. e.g. `Yeoh Alex` will match `Alex Yeoh`. -- Only full words will be matched e.g., `Han` will not match `Hans`. +- The search is case-insensitive. e.g., `Labrador` will match `LABRADOR`. +- The order of the keywords does not matter. e.g. `Bukit Timah` will match `Timah Bukit`. - Students matching at least one keyword will be returned. e.g., `Hans Bo` will return `Hans Gruber`, `Bo Yang`. Example: From f9f17f1c92674738b9dbe820b9733870aa72d5b1 Mon Sep 17 00:00:00 2001 From: gnahzeus Date: Thu, 27 Oct 2022 22:03:43 +0800 Subject: [PATCH 5/6] Update UG for address --- docs/UserGuide.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 68fc3a1c755..23d0d04ff39 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -443,11 +443,12 @@ Format: `find a/KEYWORD [MORE_KEYWORDS]` - The search is case-insensitive. e.g., `Labrador` will match `LABRADOR`. - The order of the keywords does not matter. e.g. `Bukit Timah` will match `Timah Bukit`. -- Students matching at least one keyword will be returned. e.g., `Hans Bo` will return `Hans Gruber`, `Bo Yang`. +- Students matching at least one keyword will be returned. e.g., `Bukit Timah` will return `Bukit Batok`, `Timah Hill`. +- Only full words will be matched e.g., `Labra` will not match `Labrador`. Example: -`find n/tan` returns `Tan Xiao Ming` and `John Tan`. +`find a/street` returns `Bukit Timah Street 3` and `Labrador Street 27`. #### Find by Student's Contact Number: From 19d6ac8264391b1270e6138b13e0f48fc732b69c Mon Sep 17 00:00:00 2001 From: Echomo Xinyu Date: Fri, 28 Oct 2022 04:07:13 +0800 Subject: [PATCH 6/6] Fix syntactic errors --- docs/UserGuide.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 23d0d04ff39..a11a26048f5 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -419,9 +419,9 @@ Example: Finds all students with a particular email. -Formats: `find e/EMAIL +Format: `find e/EMAIL` -- The search is case-insensitive. e.g., `ghost@woods.com` will match `ghOst@woOds.com`. +- The search is case-insensitive. e.g., `ghost@woods.com` will match `ghoSt@woOds.com`. - Only one email can be searched at each time. - Full email must be used for corresponding student to be found e.g., `ghost` will not match `ghost@woods.com`. @@ -431,18 +431,18 @@ Formats: `find e/EMAIL find e/jonsnow@winterfell.com ghost@woods.com. ``` -Examples: +Example: `find e/jonsnow@winterfell.com` returns all students with email set as `jonsnow@winterfell.com`. -#### Find by address: +#### Find by Address: Finds all students with addresses matching the keywords. Format: `find a/KEYWORD [MORE_KEYWORDS]` - The search is case-insensitive. e.g., `Labrador` will match `LABRADOR`. -- The order of the keywords does not matter. e.g. `Bukit Timah` will match `Timah Bukit`. +- The order of the keywords does not matter. e.g., `Bukit Timah` will match `Timah Bukit`. - Students matching at least one keyword will be returned. e.g., `Bukit Timah` will return `Bukit Batok`, `Timah Hill`. - Only full words will be matched e.g., `Labra` will not match `Labrador`. @@ -720,8 +720,8 @@ A: Install the app in the other computer and overwrite the empty data file it cr | Edit a student | edit INDEX [n/NAME] [p/CONTACT_NUMBER] [np/NEXT_OF_KIN_CONTACT_NUMBER] [a/ADDRESS] [e/EMAIL] [dt/CLASS_DATE] [paid/AMOUNT_PAID] [owed/AMOUNT_OWED] [nt/ADDITIONAL_NOTES] [nt-a/ADDITIONAL_NOTES_APPEND] `e.g., edit 2 p/98765431` | | Get help | `help` | | List all students | `list` | -| Find a student | find n/NAME `e.g., find n/John Doe` or other supported fields | -| Mark a student | mark INDEX-s `e.g., mark 2` | +| Find a student | find n/NAME e.g., `find n/John Doe` or other supported fields | +| Mark a student | mark INDEX-s e.g., `mark 2` | | Receive money from a student | pay INDEX-s AMOUNT_PAID `e.g., pay 2 300` | | Delete a student | delete INDEX `e.g., delete 2` | | Clear all students | `clear` |