Skip to content

Commit

Permalink
Merge pull request #155 from drustanyjt/drus-ug-show
Browse files Browse the repository at this point in the history
Add Show command to UG
  • Loading branch information
drustanyjt authored Apr 4, 2024
2 parents b18f11a + 6b8fe06 commit 4ab3b64
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -211,6 +211,29 @@ Examples:
What a successful `find` command looks like:
![successful_find](images/successfulfind.png)

### Changing the displayed note: `show`

There are 2 ways to use the `show` command:
1. If an IC_NUMBER is provided, displays the full note of the person with the specified IC_NUMBER on the right.
2. If no IC_NUMBER is provided, clears the note display on the right.

Format: `show [IC_NUMBER]`

For the first case where an IC_NUMBER is provided:
* Rules for valid IC_NUMBER are the same as the `find` command.
* Displays the full note of the person with the specified IC_NUMBER.
* Does NOT modify the list of persons displayed.

Example:
* `show T0123456A` updates the note display on the right to show `John Doe`'s note.

For the second case where no IC_NUMBER is provided:
* Clears the note display on the left.
* Does NOT modify the list of persons displayed.

Example:
* `show` clears any note that was being displayed on the right.

### Deleting a person : `delete`

Deletes the specified person from ClinicMate using their IC_NUMBER.
Expand Down

0 comments on commit 4ab3b64

Please sign in to comment.