Skip to content

Commit

Permalink
Merge pull request #237 from tsulim/205-fav-unfav-ug
Browse files Browse the repository at this point in the history
Update user guide on the behavior of `fav` and `unfav`
  • Loading branch information
whitesnowx authored Apr 12, 2024
2 parents 4bab970 + de40f2b commit 623ba30
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
@@ -322,10 +322,15 @@ Examples:
![Result of deletion](images/AfterDeleteCommand1.png)
<br>**List all persons and Bernice is deleted:**<br>
![Result of deletion](images/AfterDeleteCommand2.png)

### Setting a person as favourite: `fav`

Sets the specified person from the contacts as favourite.

<div markdown="block" class="alert alert-info">:information_source: **Note:**
The displayed view in StaffConnect will reset to the default view after the `fav` command is called.
</div>

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.

<div markdown="block" class="alert alert-info">:information_source: **Note:**
The displayed view in StaffConnect will reset to the default view after the `unfav` command is called.
</div>

Format: `unfav INDEX`

* Removes the person at the specified `INDEX`.

0 comments on commit 623ba30

Please sign in to comment.