Skip to content

Commit

Permalink
Merge pull request #243 from tsulim/239-edit-ug
Browse files Browse the repository at this point in the history
Update user guide on the behavior of `edit`
  • Loading branch information
iynixil authored Apr 12, 2024
2 parents 5b6fee0 + 45c7ee5 commit 9e291e4
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,15 @@ Format: `list`

Edits an existing person in the contacts.

<div markdown="block" class="alert alert-info">

**:information_source: Notes:**<br>

* The displayed view in StaffConnect will reset to the default view after the `edit` command is called.

* The changes made are displayed in the result display above the command box.
</div>

Format: `edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [m/MODULE] [f/FACULTY] [v/VENUE] [t/TAG]…​ [a/AVAILABILITY]…​`

* Edits the person at the specified `INDEX`. The index refers to the index number shown in the displayed person list. The index **must be a positive integer** 1, 2, 3, …​
Expand Down

0 comments on commit 9e291e4

Please sign in to comment.