From de40f2b650d4939c0290a722653f325fc08b518f Mon Sep 17 00:00:00 2001 From: tsulim Date: Fri, 12 Apr 2024 07:12:36 +0800 Subject: [PATCH] Update user guide on functionality of `fav` and `unfav` --- docs/UserGuide.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 1a36feef1f9..e1f7c604c7d 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -322,10 +322,15 @@ Examples: ![Result of deletion](images/AfterDeleteCommand1.png)
**List all persons and Bernice is deleted:**
![Result of deletion](images/AfterDeleteCommand2.png) + ### Setting a person as favourite: `fav` Sets the specified person from the contacts as favourite. +
:information_source: **Note:** +The displayed view in StaffConnect will reset to the default view after the `fav` command is called. +
+ Format: `fav INDEX` * Sets the person at the specified `INDEX`. @@ -336,12 +341,17 @@ Examples: * `list` followed by `fav 2` sets the 2nd person as favourite in the contacts. * `sort p/` followed by `fav 1` sets the 1st person as favourite in the contacts in the results of the `sort` command, which should be the person with the smallest phone number. * `find Betsy` followed by `fav 1` sets the 1st person as favourite in the results of the `find` command. + ![Result of fav command](images/AfterFavCommand.png) ### Removes a person as favourite: `unfav` Removes the specified person from the contacts as favourite. +
:information_source: **Note:** +The displayed view in StaffConnect will reset to the default view after the `unfav` command is called. +
+ Format: `unfav INDEX` * Removes the person at the specified `INDEX`.