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

UG: explain product update editClient #304

Merged
merged 7 commits into from
Nov 6, 2022
Merged

UG: explain product update editClient #304

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
cc3a727
UG: explain product update editClient
Thing1Thing2 Nov 2, 2022
087ec2a
update ug
Thing1Thing2 Nov 6, 2022
2d6b9fe
merge master
Thing1Thing2 Nov 6, 2022
9f2a1db
Merge branch 'master' of https://github.com/AY2223S1-CS2103T-W16-4/tp…
Thing1Thing2 Nov 6, 2022
e00ed76
explain multiple pd prefix use
Thing1Thing2 Nov 6, 2022
2a7c262
Add multiple product examples
Thing1Thing2 Nov 6, 2022
10a7326
Fix backslash
Thing1Thing2 Nov 6, 2022
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: 6 additions & 1 deletion docs/UserGuide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -323,7 +323,7 @@ Format: `addClient n/NAME p/PHONE_NUMBER [a/ADDRESS] [e/EMAIL] [b/BIRTHDAY] [pd/
* `PHONE_NUMBER` should contain only numbers and be at least 8 digits long.
* `EMAIL`, `BIRTHDAY`, `ADDRESS` and `PRODUCT` are optional.
* `BIRTHDAY` in the future are not acceptable.
* `PRODUCT` must exists already.
* `PRODUCT` must exists already. You can add multiple products to the client. Reuse `pd/` prefix to add each product to the client.
* If a `NAME` already exists in _MyInsuRec_, adding the same `NAME` will result in an error!

Use case:
Expand All @@ -340,6 +340,8 @@ Examples:
* `addClient n/John Tan p/12345678 b/12122000`
* Same as above, but with even more details
* `addClient n/John Tan p/12345678 e/johntan@insurec.com a/123 ABC ROAD, #11-01 pd/Product1`
* Same as above, but with multiple products
* `addClient n/John Tan p/12345678 e/johntan@insurec.com a/123 ABC ROAD, #11-01 pd/Product1 pd/Product2 pd/Product3`

#### 7.1.2 List clients: `listClient`

Expand Down Expand Up @@ -426,6 +428,7 @@ Format: `editClient i/INDEX [n/NAME] [p/PHONE_NUMBER] [a/ADDRESS] [e/EMAIL] [b/B
* At least one optional detail must be modified.
* Maintain value of details not edited by the command.
* If you wish to edit a client's `NAME` and the `NAME` already exists in _MyInsuRec_, it will result in an error!
* Editing the client's products replaces all existing products with the products specified. You can add multiple products to the client. Reuse `pd/` prefix to add each product to the edited client.

Use case:
1. A client changed his address! Update the client details instead of having to removing the old record and creating a new record.
Expand All @@ -437,6 +440,8 @@ Suppose MyInsuRec contains only one client 'John Tan' having phone number '01234
* `editClient i/1 n/John Smith`
* Add email 'johntan@insurec.com'
* `editClient i/1 e/johntan@insurec.com`
* Add multiple products
* `editClient i/1 pd/Product1 pd/Product2`

<div markdown="span" class="alert alert-success">**:bulb: Tips and tricks:**
We are using `NAME` as a unique identifier because we have considered cases where parents will be using their contact details for their children. If you are stuck in a situation where both clients have the same name, you can add a few words to make them unique, for example John Tan NUS and John Tan SMU.
Expand Down