Skip to content

Commit

Permalink
Merge pull request #117 from Jiwei99/branch-UserGuide
Browse files Browse the repository at this point in the history
Minor UG fix for helpCommand
  • Loading branch information
Jiwei99 authored Oct 28, 2021
2 parents 934e164 + e99eb9f commit 54a34e6
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,8 @@ Finds all persons whose names **and** tags matches ALL keywords provided.

Notes:
* `find` is case-insensitive by default. e.g. `hans` will match `Hans`
* However, users can opt for case-sensitive search by including the `c/` flag after the command word
* However, users can opt for case-sensitive search by including the `c/` flag **after** the command word.
* `c/` case-sensitive search applies **ONLY** to tags
* The order of the keywords does not matter. e.g. `n/Hans t/football` will return the same result as
`t/friends n/Hans`
* Both name and tags are searched.
Expand Down Expand Up @@ -225,6 +226,8 @@ Finds all persons whose names **or** tags contain ANY of the given keywords.

Notes:
* `findAny` is case-insensitive by default. e.g. `hans` will match `Hans`
* However, users can opt for case-sensitive search by including the `c/` flag **after** the command word.
* `c/` case-sensitive search applies **ONLY** to tags
* The order of the keywords does not matter. e.g. `Hans Bo` will match `Bo Hans`
* Both name and tags are searched.
* Only full words will be matched e.g. `Han` will not match `Hans`
Expand Down Expand Up @@ -394,7 +397,7 @@ Action | Summary | Format, Examples
**FindAny** | Locates persons by name and tags (Results fulfill at least one search term)| `findAny n/NAME [n/NAME] t/TAG [t/TAG]`<br> e.g., `findAny n/James t/NUS`
**Pin** | Pins a person | `pin INDEX`<br> e.g., `pin 1`
**Unpin** | Unpins a person | `unpin INDEX`<br> e.g., `unpin 1`
**Help** | Displays help information | `help [COMMAND] [/d]`
**Help** | Displays help information | `help [COMMAND]`<br> e.g., `help`, `help add`, `help more`
**List** | Lists all persons | `list`
**Tag** | Tags a person | `tag INDEX [t/TAG]…​`<br> e.g., `tag 2 t/friend t/NUS`
**Untag** | Untags a person | `untag INDEX [t/TAG]…​`<br> e.g., `untag 2 t/colleague`

0 comments on commit 54a34e6

Please sign in to comment.