From a667ac6f84d5d0372b39cbdb667c1d79a03f7c1a Mon Sep 17 00:00:00 2001 From: logical-1985516 Date: Thu, 29 Feb 2024 00:20:47 +0800 Subject: [PATCH] Add examples and clarify the behaviour of search --- docs/UserGuide.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 0391c4a03b7..830731ea67c 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -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`