forked from nus-cs2103-AY2425S1/tp
-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update User guide with description params added to instructions
- Loading branch information
Showing
1 changed file
with
13 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -27,7 +27,7 @@ ClientHub is a **desktop app for managing contacts, optimized for use via a Comm | |
|
|
||
| * `list` : Lists all contacts. | ||
|
|
||
| * `add n/John Doe p/98765432 e/[email protected] a/John street, block 123, #01-01` : Adds a contact named `John Doe` to the Address Book. | ||
| * `add n/John Doe p/98765432 e/[email protected] a/John street, block 123, #01-01 d/likes ramen` : Adds a contact named `John Doe` to the Address Book. | ||
|
|
||
| * `delete 3` : Deletes the 3rd contact shown in the current list. | ||
|
|
||
|
|
@@ -96,7 +96,7 @@ Format: `list` | |
|
|
||
| Edits an existing person in the address book. | ||
|
|
||
| Format: `edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [c/CLIENT_TYPE]…` | ||
| Format: `edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [c/CLIENT_TYPE]… [d/DESCRIPTION]` | ||
|
|
||
| * Edits the person at the specified `INDEX`. The index refers to the index number shown in the displayed person list. The index **must be a positive integer** 1, 2, 3, … | ||
| * At least one of the optional fields must be provided. | ||
|
|
@@ -223,14 +223,14 @@ _Details coming soon ..._ | |
|
|
||
| ## Command summary | ||
|
|
||
| | Action | Format, Examples | | ||
| |-----------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ||
| | **Add** | `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [c/CLIENT_TYPE]…` <br> e.g., `add n/James Ho p/22224444 e/[email protected] a/123, Clementi Rd, 1234665 c/Plan A c/Plan A` | | ||
| | **Clear** | `clear` | | ||
| | **Delete** | `delete INDEX`<br> e.g., `delete 3` | | ||
| | **Edit** | `edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [c/CLIENT_TYPE]…`<br> e.g.,`edit 2 n/James Lee e/[email protected]` | | ||
| | **Find** | `find KEYWORD [MORE_KEYWORDS]`<br> e.g., `find James Jake` | | ||
| | **Find Phone Number** | `fp KEYWORD` | | ||
| | **Find Address** | `fa KEYWORD(s)` | | ||
| | **List** | `list` | | ||
| | **Help** | `help` | | ||
| | Action | Format, Examples | | ||
| |-----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ||
| | **Add** | `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [c/CLIENT_TYPE]… [d/DESCRIPTION]` <br> e.g., `add n/James Ho p/22224444 e/[email protected] a/123, Clementi Rd, 1234665 c/Plan A c/Plan A d/crimefighter` | | ||
| | **Clear** | `clear` | | ||
| | **Delete** | `delete INDEX`<br> e.g., `delete 3` | | ||
| | **Edit** | `edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [c/CLIENT_TYPE]… [d/DESCRIPTION]`<br> e.g.,`edit 2 n/James Lee e/[email protected]` | | ||
| | **Find** | `find KEYWORD [MORE_KEYWORDS]`<br> e.g., `find James Jake` | | ||
| | **Find Phone Number** | `fp KEYWORD` | | ||
| | **Find Address** | `fa KEYWORD(s)` | | ||
| | **List** | `list` | | ||
| | **Help** | `help` | | ||