diff --git a/docs/UserGuide.md b/docs/UserGuide.md index d21d77f0542..26eda14c85e 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -507,19 +507,41 @@ Index out of range:
#### 2.1.4 Listing all applicant: `list` ![listUI-1](images/listUI-1.png) ![listUI-2](images/listUI-2.png) - + + +Shows a list of all applicants. + + + + -**Format:** `list` / `list-hidden` / `list-bookmarked` +**Format:** -- `list` - - Shows a list of all applicants. -- `list-hidden` - - Shows a list of all hidden applicants. -- `list-bookmarked` - - Shows a list of all bookmarked applicants. +**`list`** / **`list-hidden`** / **`list-bookmarked`** + + + +**`list`** +- Shows a list of all applicants. + + + + + +**`list-hidden`** +- Shows a list of all hidden applicants. + + + + + +**`list-bookmarked`** +- Shows a list of all bookmarked applicants. + + + + --- @@ -527,93 +549,200 @@ Index out of range:
![edit function UI](images/viewUI.png) - +Displays a single applicant. -**Format:** `view INDEX` + + + + +**Format:** -- `INDEX`: The index corresponding to the applicant to be displayed. The index must be a positive integer (e.g., 1, 2, 3…). +**`view INDEX`** + + + +**`INDEX`**: The index corresponding to the applicant to be displayed. The index must be a positive integer (e.g., 1, 2, 3…). + + + + + + **Examples:** -- **`view 3`** - - Displays the following details about the third applicant. - - Name - - Student number - - Phone number - - Email Address - - GPA - - Comments - - Tags + + +**`view 3`** +- Displays the following details about the third applicant. + - Name + - Student number + - Phone number + - Email Address + - GPA + - Comments + - Tags + + + + + + **Expected Outputs:** -- Successfully displaying all details of an applicant in the following format:\ - `Name: John Doe`\ - `Student number: A0358289S`\ - `Phone Number: 91234567`\ - `Email Address: johndoe@example.come`\ - `GPA: 5.0`\ - `Comments: Good fit, has teaching experience`\ - `Tags: pastTA, deansList` -- Confirmation message:
-`"Displaying: APPLICANT_NAME"` + + +Successfully displaying all details of an applicant in the following format:\ +- **`Name: John Doe`** +- **`Student number: A0358289S`** +- **`Phone Number: 91234567`** +- **`Email Address: johndoe@example.come`** +- **`GPA: 5.0`** +- **`Comments: Good fit, has teaching experience`** +- **`Tags: pastTA, deansList`** + + + + + +Confirmation message:
+**`"Displaying: APPLICANT_NAME"`** + +
+ +
+ + + **Errors:** -- Missing index:
+ + +Missing index:
**`"Invalid command format!`
`view: Displays the applicant identified by the index number used in the displayed applicant list.`
`Parameters: INDEX (must be a positive integer)`
`Example: view 1"`** -- Index out of range:
+ +
+ + + +Index out of range:
**`"Error: Invalid index. Please enter an index within range."`** +
+ +
+ --- #### 2.1.6 Hiding an applicant from list: `hide`/`unhide` ![hide function UI](images/hideUI.png) - + -**Format:** `hide INDEX` / `unhide INDEX` / `unhide-all` +Hides/unhides an applicant from the list of applicants. -- `hide INDEX` - - Hides the applicant at the specified INDEX from all future lists. The index refers to the number shown in the displayed person list. -- `unhide INDEX` - - Unhides the applicant at the specified INDEX from all future lists. The index refers to the number shown in the displayed person list. -- `unhide-all` - - Unhides all applicants that were previously hidden. + + + + +**Format:**  + +`hide INDEX` / `unhide INDEX` / `unhide-all` + + + +`hide INDEX` +- Hides the applicant at the specified INDEX from all future lists. The index refers to the number shown in the displayed person list. + + + + + +`unhide INDEX` +- Unhides the applicant at the specified INDEX from all future lists. The index refers to the number shown in the displayed person list. + + + + + +`unhide-all` +- Unhides all applicants that were previously hidden. + + + + + + **Examples:** -- **`hide 2`** - - Hides the applicant at index 2 -- **`unhide 2`** - - Unhides the applicant at index 2 -- **`unhide-all`** - - Unhides all applicants + + +**`hide 2`** +- Hides the applicant at index 2 + + + + + +**`unhide 2`** +- Unhides the applicant at index 2 + + + + + +**`unhide-all`** +- Unhides all applicants + + + + + + **Expected Outputs:** -- Successfully hiding/unhiding applicant(s). -- Confirmation message:
+ + +Successfully hiding/unhiding applicant(s).
+Confirmation message:
**`APPLICANT_NAME hidden successfully.`** +
+ +
+ + + **Errors:** -- Missing index:
+ + +Missing index:
**`"Invalid command format!`
`hide: Hides an applicant, identified by the index number used in the last list, from all future lists of applicants.`
`Parameter: INDEX (must be a positive integer)`
`Example: hide 1"`** -- Index out of range:
+ +
+ + + +Index out of range:
**`“Error: Invalid index. Please enter an index within range.”`** +
+ +
+ --- ### **2.2 Applicant evaluation & comparison**