UG: explain product update editClient #304
Conversation
Thing1Thing2
commented
Nov 2, 2022
Thing1Thing2
commented
Codecov ReportBase: 65.18% // Head: 65.68% // Increases project coverage by
Additional details and impacted files@@ Coverage Diff @@
## master #304 +/- ##
============================================
+ Coverage 65.18% 65.68% +0.50%
- Complexity 684 725 +41
============================================
Files 113 114 +1
Lines 2275 2352 +77
Branches 260 277 +17
============================================
+ Hits 1483 1545 +62
- Misses 686 693 +7
- Partials 106 114 +8
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report at Codecov. |
docs/UserGuide.md
Outdated
| @@ -399,6 +399,7 @@ Format: `editClient i/INDEX [n/NAME] [p/PHONE_NUMBER] [a/ADDRESS] [e/EMAIL] [b/B | |||
| * `INDEX` **must be a positive integer** 1, 2, 3, … | |||
| * At least one optional detail must be modified. | |||
| * Maintain value of details not edited by the command. | |||
| * Editing the client's products removes all existing products and adds all products specified. | |||
There was a problem hiding this comment.
perhaps a more succinct way to put it is 'replaces', but this is clear enough.
…into edit-client-ug-update
|
okk i will update to say multiple product prefixes are allowed, but currently this is not mentioned in addClient, so repeating the same there as well. |
docs/UserGuide.md
Outdated
| @@ -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. Reuse `pd\` prefix to add each product to the client. | |||
There was a problem hiding this comment.
I think this description is not clear enough. A better way could be You can add multiple products to the client.
Then add one example to show how the user can add multiple products. Please do the same for editClient as well.
There was a problem hiding this comment.
Ok, made the changes. Please have a look, thank you.
docs/UserGuide.md
Outdated
| @@ -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. | |||
