Skip to content

Commit

Permalink
Add examples and clarify the behaviour of search
Browse files Browse the repository at this point in the history
  • Loading branch information
logical-1985516 committed Feb 28, 2024
1 parent 5e623bb commit a667ac6
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -153,13 +153,18 @@ Format: `clear`

Searches candidates whose attributes match the specified attributes in the search criteria.

Format: `search [n/NAME] [e/EMAIL] [c/COUNTRY] [m/COMMENT] [p/PHONE] [s/INTERVIEW_STATUS] [t/TAG]`
Format: `search [n/NAME] [e/EMAIL] [c/COUNTRY] [m/COMMENT] [p/PHONE] [s/INTERVIEW_STATUS] [t/TAG]`

* At least one of the optional fields must be provided.
* The search is case-sensitive, e.g. `hans` will not match `Hans`.
* For email, country, phone and interview status, only full words will be matched.
* For name, comment and tags, partial words will be matched, e.g. `Han` will match `Hans`.
* The search will fail if either of the email, country, phone or interview status is in an invalid format.
* If multiple fields are specified, only candidates that match **all** the specified attributes will be returned.

Examples:
* `search n/John s/ACCEPTED` returns candidates whose names contain `John` and whose interview status is `ACCEPTED`.
* `search t/Internal` returns candidates whose tags contain `Internal`.

### Exiting the program : `exit`

Expand Down

0 comments on commit a667ac6

Please sign in to comment.