Skip to content

Commit d74459f

Browse files
authored
Merge pull request nus-cs2103-AY2021S1#76 from qlchan24/update-uG-createCommand
Update User Guide: create command
2 parents 86f3544 + 52c824c commit d74459f

File tree

1 file changed

+16
-21
lines changed

1 file changed

+16
-21
lines changed

docs/UserGuide.md

Lines changed: 16 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -27,15 +27,7 @@ and efficient Graphical User Interface interaction.
2727
1. Type the command in the command box and press Enter to execute it. e.g. typing **`help`** and pressing Enter will open the help window.<br>
2828
Some example commands you can try:
2929

30-
* **`list`** : Lists all contacts.
31-
32-
* **`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.
33-
34-
* **`delete`**`3` : Deletes the 3rd contact shown in the current list.
35-
36-
* **`clear`** : Deletes all contacts.
37-
38-
* **`exit`** : Exits the app.
30+
* **`Create`** : Create a purchase order
3931

4032
1. Refer to the [Features](#features) below for details of each command.
4133

@@ -53,8 +45,8 @@ and efficient Graphical User Interface interaction.
5345
* Items in square brackets are optional.<br>
5446
e.g `n/NAME [t/TAG]` can be used as `n/John Doe t/friend` or as `n/John Doe`.
5547

56-
* Items with ``​ after them can be used multiple times including zero times.<br>
57-
e.g. `[t/TAG]…​` can be used as ` ` (i.e. 0 times), `t/friend`, `t/friend t/family` etc.
48+
* Items with ``​ after them can be used multiple times.<br>
49+
e.g. `[t/TAG]…​` can be used as `t/friend`, `t/friend t/family` etc.
5850

5951
* Parameters can be in any order.<br>
6052
e.g. if the command specifies `n/NAME p/PHONE_NUMBER`, `p/PHONE_NUMBER n/NAME` is also acceptable.
@@ -84,6 +76,17 @@ Examples:
8476
* `add n/John Doe p/98765432 e/[email protected] a/John street, block 123, #01-01`
8577
* `add n/Betsy Crowe t/friend e/[email protected] a/Newgate Prison p/1234567 t/criminal`
8678

79+
80+
### **Creating a purchase order : `create`**
81+
* Create a purchase order to track the purchase of medical products from a supplier to a store.
82+
* **Format**: `create sid/SUPPLIER_ID s/STORE_ID id/PRODUCT_ID…​ qty/PRODUCT_QUANTITY…​ date/EXPECTED_DELIVERED_DATE`
83+
* The number specified for PRODUCT_ID cannot exceed the total number of products. All the IDs must be identifiable
84+
* The number of arguments specified for PRODUCT_QUANTITY and PRODUCT_ID must match
85+
* EXPECTED_DELIVERED_DATE must be after current time and of the form YYYY-MM-DD
86+
87+
* **Examples**:
88+
* `create sid/01 s/123 id/1 2 4 8 qty/100 200 400 800 date/2020-12-12` : Creates a purchase order for the delivery of 100, 200, 400 and 800 of products with ID 1, 2, 4 and 8 respectively from supplier ID of 01 to store ID of 123 by December 12, 2020.
89+
8790
### Listing all persons : `list`
8891

8992
Shows a list of all persons in the address book.
@@ -157,9 +160,7 @@ Format: `exit`
157160

158161
AddressBook data are saved in the hard disk automatically after any command that changes the data. There is no need to save manually.
159162

160-
### Archiving data files `[coming in v2.0]`
161-
162-
_{explain the feature here}_
163+
<br />
163164

164165
--------------------------------------------------------------------------------------------------------------------
165166

@@ -174,10 +175,4 @@ _{explain the feature here}_
174175

175176
Action | Format, Examples
176177
--------|------------------
177-
**Add** | `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]…​` <br> e.g., `add n/James Ho p/22224444 e/[email protected] a/123, Clementi Rd, 1234665 t/friend t/colleague`
178-
**Clear** | `clear`
179-
**Delete** | `delete INDEX`<br> e.g., `delete 3`
180-
**Edit** | `edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [t/TAG]…​`<br> e.g.,`edit 2 n/James Lee e/[email protected]`
181-
**Find** | `find KEYWORD [MORE_KEYWORDS]`<br> e.g., `find James Jake`
182-
**List** | `list`
183-
**Help** | `help`
178+
**Create** | `create sid/SUPPLIER_ID s/STORE_ID id/PRODUCT_ID…​ qty/PRODUCT_QUANTITY…​ date/EXPECTED_DELIVERED_DATE`

0 commit comments

Comments
 (0)