diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 243273ec577..5877e0f02c5 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -751,21 +751,44 @@ Index out of range:
![sort function UI](images/sortUI.png) - + -**Format:** **`sort-gpa`** +**Format:** + +**`sort-gpa`** + + + + **Expected Output:** + + - A list of applicants sorted by grades in descending order. + + + + + + **Errors:** -- Empty list:
-`"No applicants to sort."` + + +Empty list:
+**`"No applicants to sort."`** + +
+ +
--- @@ -773,24 +796,52 @@ Index out of range:
![compare function UI](images/compareUI.png) - +**`compare INDEX1 INDEX2`** + + + +**`INDEX1`**: The index of the first applicant to compare. + + + + + +**`INDEX2`**: The index of the second applicant to compare.
+Both indices must be a positive integer (e.g., 1, 2, 3…), and should not be the same. + +
-**Format:** **`compare INDEX1 INDEX2`** + -- **`INDEX1`**: The index of the first applicant to compare. -- **`INDEX2`**: The index of the second applicant to compare. -- Both indices must be a positive integer (e.g., 1, 2, 3…), and should not be the same. + **Examples:** -- **`compare 1 2`** - - Compares the first and second applicants. + + +**`compare 1 2`** +- Compares the first and second applicants. + + + + + + **Expected Output:** + + - A side-by-side comparison of the two applicants is displayed in a user-friendly format. - This comparison window will include: - Student number @@ -802,83 +853,191 @@ Index out of range:
- tags - The system highlights the differences between the two applicants, making it easy to see variations in their profiles. +
+ +
+ + + **Errors:** -- Applicant not found:
+ + +Applicant not found:
**`"Error: One or both of the specified applicants were not found in the list."`** -- Comparing the same applicant:
+ +
+ + + +Comparing the same applicant:
**`"Error: Please provide distinct indices. You cannot compare the same applicant."`** +
+ +
+ --- #### 2.2.3 Bookmarking/Unbookmarking applicants: `bookmark/unbookmark` ![bookmark function UI](images/bookmarkUI.png) - +Bookmarks/Unbookmarks a specific applicant. -**Format:** **`bookmark INDEX` / `unbookmark INDEX`** + + + + +**Format:** + +**`bookmark INDEX` / `unbookmark INDEX`** + + + +**`INDEX`**: The index corresponding to the applicant to be bookmarked/unbookmarked. The index must be a positive integer (e.g., 1, 2, 3…). + + + + -- **`INDEX`**: The index corresponding to the applicant to be bookmarked/unbookmarked. The index must be a positive integer (e.g., 1, 2, 3…). + **Examples:** -- **`bookmark 3`** - - Bookmarks the third applicant. -- **`unbookmark 3`** - - Unbookmarks the third applicant. + + +**`bookmark 3`** +- Bookmarks the third applicant. + + + + + +**`unbookmark 3`** +- Unbookmarks the third applicant. + + + + + + **Expected Output:** + + - Successfully bookmark/unbookmark applicant at the given index. -- Confirmation message: -`"Applicant at index INDEX has been successfully bookmarked/unbookmarked."` +- Confirmation message:
+**`"Applicant at index INDEX has been successfully bookmarked/unbookmarked."`** + +
+ +
+ + **Errors:** -- Missing index:
+ + +Missing index:
**`"Invalid command format!`
`bookmark: Bookmarks 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: bookmark 1"`** -- Index out of range:
+ +
+ + + +Index out of range:
**`"Error: Invalid index. Please enter an index within range."`** +
+ +
+ --- #### 2.2.4 Commenting on TA applicant: **`comment`** ![comments.jpg](images/comment.jpg) - + + +Add comments on a specific applicant + + + + + +**Format:** + +**`comment INDEX COMMENT`** + + + +**`INDEX`**: The index corresponding to the applicant to be commented. The index must be a positive integer (e.g., 1, 2, 3…). + + + + + +**`COMMENT`:** The comment to be made about the applicant. + + -**Format: `comment INDEX COMMENT`** + -- `INDEX`: The index corresponding to the applicant to be commented. The index must be a positive integer (e.g., 1, 2, 3…). -- **`COMMENT`:** The comment to be made about the applicant. + **Examples:** -- `comment 3 Hardworking and studious` - - Comments on the third applicant with the comment: "Hardworking and studious" + + +**`comment 3 Hardworking and studious`** +- Comments on the third applicant with the comment: "Hardworking and studious" + + + + + + **Expected outputs:** + + - Successfully commenting on the applicant at the corresponding index. - Confirmation message:
-`"Applicant at index INDEX has been successfully commented on."` +**`"Applicant at index INDEX has been successfully commented on."`** + +
+ +
+ + **Errors:** -- Missing index:
-`“Error: Missing index. Please follow the format: 'view INDEX'.”` -- Index out of range:
-`“Error: Invalid index. Please enter an index within range.”` + + +Missing index:
+**`“Error: Missing index. Please follow the format: 'view INDEX'.”`** + +
+ + + +Index out of range:
+**`“Error: Invalid index. Please enter an index within range.”`** + +
+ +
---