Skip to content

Commit

Permalink
Change find and help descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
KrashKart committed Nov 6, 2024
1 parent 1322e94 commit fa7ad9e
Show file tree
Hide file tree
Showing 5 changed files with 13 additions and 5 deletions.
16 changes: 11 additions & 5 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,13 +98,14 @@ Action | Format, Examples

### Viewing help : `help`

Shows a message explaining how to access the help page.
Shows a message with a clickable hyperlink.

When clicked, this hyperlink will show the help page.

![help message](images/helpMessage.png)

Format: `help`


### Adding a person: `add`

Adds a person to CampusConnect.
Expand Down Expand Up @@ -159,10 +160,15 @@ Format:
* Persons matching at least one keyword will be returned (i.e. `OR` search).
e.g. `Hans Bo` will return `Hans Gruber`, `Bo Yang`

How `find` works with multiple parameters:
* If multiple keywords for a field are present, `find` will display contacts that satisfy *any* keyword for that field.
* If multiple fields are present, `find` will display contacts that satisfy **all** of these fields.

Examples:
* `find n/John` returns `johnathon` and `John Doe`
* `find n/bernice t/floor` returns `Bernice Yu` and all contacts with tags containing `floor`<br>
![result for 'find n/bernice t/floor'](images/findBerniceFloorResult.png)
* `find n/bernice t/is1108` returns `Bernice Yu`<br>
![result for 'find n/bernice t/is1108'](images/findBerniceIS1108Result.png)
* `find t/floor t/run` returns all contacts with any tag containing `floor` or `run` <br>
![result for 'find t/floor t/run'](images/findFloorRunResult.png)

### Deleting a person : `delete`

Expand Down
2 changes: 2 additions & 0 deletions docs/images/desktop.ini
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
[LocalizedFileNames]
Screenshot 2024-11-06 125806.png=@Screenshot 2024-11-06 125806,0
Binary file removed docs/images/findBerniceFloorResult.png
Binary file not shown.
Binary file added docs/images/findBerniceIS1108Result.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/findFloorRunResult.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit fa7ad9e

Please sign in to comment.