Skip to content

Commit

Permalink
Merge pull request nus-cs2103-AY2122S1#79 from KT27Learn/master
Browse files Browse the repository at this point in the history
Update add command user guide description
  • Loading branch information
benedictchuajj authored Oct 13, 2021
2 parents 93a81f7 + 4ea7ced commit e0d25b9
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Finding your next lead has never been easier.
* [Quick Start](#quick-start)
* [Client Information](#client-information)
* [Features](#features)
* [Create new contact: create](#create-new-contact--create)
* [Create new contact: add](#create-new-contact--create)
* [Retrieve particular contact: view](#retrieve-particular-contact--view)
* [Update existing contact: edit](#update-existing-contact--edit)
* [Delete particular contact: delete](#delete-particular-contact--delete)
Expand Down Expand Up @@ -94,19 +94,19 @@ Address | String | a/
</div>


### Create New Contact : `create`
### Create New Contact : `add`

Adds a new client to the address book.

Format: `create {client’s name} <email>/{email} <phone-no>/{phone number} <risk-appetite>/{risk appetite}...​`
Format: `add {client’s name} <email>/{email} <phone-no>/{phone number} <risk-appetite>/{risk appetite}...​`

* A client must have minimally the name and email tag filled during creation
* Any other tags are optional
* Tags that can be added are as seen in the client information in the Client Info Section

Examples:
* `create Benedict Chua e/benchua@hotmail.com`
* `create Keith e/keithtan@ymail.com p/12345678 r/4`
* `add Benedict Chua e/benchua@hotmail.com`
* `add Keith e/keithtan@ymail.com p/12345678 r/4`


### Retrieve Particular Contact : `view`
Expand Down Expand Up @@ -245,7 +245,7 @@ If your changes to the data file makes its format invalid, AddressBook will disc

Action | Format | Examples
--------|---------|---------
**Create** | `create {client’s name} <email>/{email} <phone-no>/{phone number} <risk-appetite>/{risk appetite}`| create benedict e/benedict@gmail.com p/90909898 r/3 |
**Create** | `add {client’s name} <email>/{email} <phone-no>/{phone number} <risk-appetite>/{risk appetite}`| add benedict e/benedict@gmail.com p/90909898 r/3 |
**View** | `view {client’s id number}` | view 123 |
**Delete** | `delete <attribute>/{value}` | delete i/4 |
**Edit** | `update {Client’s id number} <attribute>/{change value of attribute}` | update 1234 n/Dominic p/12345678 |
Expand Down

0 comments on commit e0d25b9

Please sign in to comment.