Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Minor UG fix for helpCommand #117

Merged
merged 4 commits into from
Oct 28, 2021
Merged

Minor UG fix for helpCommand #117

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
eb935d0
Merge branch 'master' into branch-UserGuide
Jiwei99 Oct 28, 2021
ac226bf
Minor update for UG
Jiwei99 Oct 28, 2021
cfcd7e5
Minor UG fix
Jiwei99 Oct 28, 2021
e99eb9f
Update UG for case sensitive search
Jiwei99 Oct 28, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions docs/UserGuide.md
View file
Open in desktop
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`