Skip to content

Commit

Permalink
Merge pull request #156 from shurvirarora/amend-ug
Browse files Browse the repository at this point in the history
Amend UserGuide
  • Loading branch information
SimJM authored Apr 6, 2022
2 parents b181106 + 0568c82 commit 71d76d2
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 13 deletions.
24 changes: 12 additions & 12 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ This personalised university contact list ensures that users do not have to cont
<ol>
<li><a href="#find-contacts-matching-all-keywords--find-">Find contacts matching ALL keywords</a></li>
<li><a href="#find-contacts-matching-any-keywords--find-wide-">Find contacts matching ANY keywords</a></li>
<li><a href="#find-contacts-by-tags-find-tag-">Find contacts by tags</a></li>
<li><a href="#find-contacts-by-tags-tag-">Find contacts by tags</a></li>
</ol>
</details>
<details open>
Expand Down Expand Up @@ -194,7 +194,7 @@ ________________________________________________________________________________
<ol>
<li><a href="#find-contacts-matching-all-keywords--find-">Find contacts matching ALL keywords</a></li>
<li><a href="#find-contacts-matching-any-keywords--find-wide-">Find contacts matching ANY keywords</a></li>
<li><a href="#find-contacts-by-tags-find-tag-">Find contacts by tags</a></li>
<li><a href="#find-contacts-by-tags-tag-">Find contacts by tags</a></li>
</ol>
</details>
<details open>
Expand Down Expand Up @@ -409,7 +409,7 @@ Examples:
* `find-wide David Computing` returns contacts with the name `David` **or** are from `Computing`
* `find-wide David Professor` returns contacts with the name `David` **or** have `Professor` as their role

### Find contacts by tags: `find-tag ...`
### Find contacts by tags: `tag ...`

Find contacts whose attributed tags meet the given keywords.

Expand All @@ -423,13 +423,13 @@ Find contacts whose attributed tags meet the given keywords.
* The search is case-insensitive. e.g `colleague` will match `Colleague`
* Only tags are included in the search, other fields are ignored.

Format: `find-tag <TAG> [MORE_TAGS]`
Format: `tag <TAG> [MORE_TAGS]`

> :bulb: **TIP** Attaching tags to a contact are a way to attach your own meaning to the contact, e.g. Adding the `CS2103T` tag to your professor's contact.
Examples:
* `find-tag CS2103T` Lists all contacts that have `CS2103T` tag
* `find-tag colleague bestie` Lists all contacts that have `colleague` or `bestie` tag.
* `tag CS2103T` Lists all contacts that have `CS2103T` tag
* `tag colleague bestie` Lists all contacts that have `colleague` or `bestie` tag.

## Favourite Commands

Expand Down Expand Up @@ -546,7 +546,6 @@ ________________________________________________________________________________

## Command summary

> :spiral_notepad: **NOTE:** KEYWORD refers to either NAME, ROLE or FACULTY

### Category: General Commands

Expand Down Expand Up @@ -576,12 +575,13 @@ The following commands are used in dealing with contacts.

The following commands are used in dealing with finding contacts.

| Function | Format Of Command |
|-------------------------------------------|-------------------------------------|
| **Find contact(s) matching ALL keywords** | `find KEYWORD [MORE_KEYWORDS]` |
| **Find contact(s) matching ANY keywords** | `find-wide KEYWORD [MORE_KEYWORDS]` |
| **Find contact(s) by tags** | `find-tag TAG` |
| Function | Format Of Command |
|---------------------------------------------|-------------------------------------|
| **Find contact(s) matching ALL keywords** | `find KEYWORD [MORE_KEYWORDS]` |
| **Find contact(s) matching ANY keywords** | `find-wide KEYWORD [MORE_KEYWORDS]` |
| **Find contact(s) by tags** | `tag TAG` |

> :spiral_notepad: **NOTE:** KEYWORD refers to either NAME, ROLE or FACULTY
### Category: Favourite Commands

Expand Down
2 changes: 1 addition & 1 deletion src/main/java/seedu/address/logic/commands/TagCommand.java
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
*/
public class TagCommand extends Command {

public static final String COMMAND_WORD = "find-tag";
public static final String COMMAND_WORD = "tag";

public static final String MESSAGE_USAGE = COMMAND_WORD + ": Finds all persons whose tags contain any of "
+ "the specified keywords (case-insensitive) and displays them as a list with index numbers.\n"
Expand Down

0 comments on commit 71d76d2

Please sign in to comment.