forked from nus-cs2103-AY2223S1/tp
-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #215 from gnahzeus/v1.3-gnahzeus-UG-update
Update UG for find by email and address
- Loading branch information
Showing
1 changed file
with
38 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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) | ||
|
@@ -421,6 +421,41 @@ Example: | |
|
||
![UiFindName](images/UG-screenshots/UiFindName.png) | ||
|
||
#### Find by Email: | ||
|
||
Finds all students with a particular email. | ||
|
||
Format: `find e/EMAIL` | ||
|
||
- The search is case-insensitive. e.g., `[email protected]` will match `[email protected]`. | ||
- 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 `[email protected]`. | ||
|
||
```yaml | ||
❗Caution: | ||
Do not include more than one email such as | ||
find e/[email protected] [email protected]. | ||
``` | ||
|
||
Example: | ||
|
||
`find e/[email protected]` returns all students with email set as `[email protected]`. | ||
|
||
#### 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`. | ||
- 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 a/street` returns `Bukit Timah Street 3` and `Labrador Street 27`. | ||
|
||
#### Find by Student's Contact Number: | ||
|
||
Finds student with the matching contact number. | ||
|