Skip to content

Commit 88a43ac

Browse files
authored
Merge pull request nus-cs2103-AY2021S1#77 from zhengweii/update-user-guide
Update UG for find command
2 parents d74459f + 7e57f4a commit 88a43ac

File tree

1 file changed

+17
-12
lines changed

1 file changed

+17
-12
lines changed

docs/UserGuide.md

Lines changed: 17 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -110,23 +110,21 @@ Examples:
110110
* `edit 1 p/91234567 e/[email protected]` Edits the phone number and email address of the 1st person to be `91234567` and `[email protected]` respectively.
111111
* `edit 2 n/Betsy Crower t/` Edits the name of the 2nd person to be `Betsy Crower` and clears all existing tags.
112112

113-
### Locating persons by name: `find`
113+
### Finding medical products / suppliers: `find`
114114

115-
Finds persons whose names contain any of the given keywords.
115+
Finds medical products / suppliers whose information contains any of the given keywords.
116116

117-
Format: `find KEYWORD [MORE_KEYWORDS]`
117+
Format: `find TYPE KEYWORD`
118118

119-
* The search is case-insensitive. e.g `hans` will match `Hans`
120-
* The order of the keywords does not matter. e.g. `Hans Bo` will match `Bo Hans`
121-
* Only the name is searched.
122-
* Only full words will be matched e.g. `Han` will not match `Hans`
123-
* Persons matching at least one keyword will be returned (i.e. `OR` search).
124-
e.g. `Hans Bo` will return `Hans Gruber`, `Bo Yang`
119+
* `TYPE` takes in either `product` / `supplier`.
120+
* `KEYWORD` is case-insensitive.
121+
* The search is case-insensitive.
122+
* Searches only the name and additional information of the products and suppliers.
123+
* Only full words will be matched e.g. `Han` will not match `Hans`.
125124

126125
Examples:
127-
* `find John` returns `john` and `John Doe`
128-
* `find alex david` returns `Alex Yeoh`, `David Li`<br>
129-
![result for 'find alex david'](images/findAlexDavidResult.png)
126+
* `find product panadol` returns all medical products containing `panadol` in its name or additional description.
127+
* `find supplier Kent Ridge` returns all suppliers that are located in `Kent Ridge`.
130128

131129
### Removing a purchase order/store/product/supplier : `delete` [Coming soon]
132130

@@ -175,4 +173,11 @@ AddressBook data are saved in the hard disk automatically after any command that
175173

176174
Action | Format, Examples
177175
--------|------------------
176+
**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`
178177
**Create** | `create sid/SUPPLIER_ID s/STORE_ID id/PRODUCT_ID…​ qty/PRODUCT_QUANTITY…​ date/EXPECTED_DELIVERED_DATE`
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 TYPE KEYWORD`<br> e.g. `find product panadol`
182+
**List** | `list`
183+
**Help** | `help`

0 commit comments

Comments
 (0)