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.

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

Edit ug1 #147

Merged
merged 2 commits into from
Mar 30, 2023
Merged
Changes from all commits
Commits
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
33 changes: 14 additions & 19 deletions docs/UserGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -198,39 +198,34 @@ Format: `list`

### Filter patients by attribute: `find`

Find patients according to a particular attribute stated followed by the change.
Find patients according to a particular command prefix stated followed by the change.

Command Prefixes that can be searched:
* name(`n/`)
* nric(`i/`)
* tag(`t/`)
* doctor(`ad/`)
* medicine(`m/`)
Command Prefixes that can be searched:
* name(`n/`)
* nric(`i/`)
* tag(`t/`)
* doctor(`ad/`)
* medicine(`m/`)

<div markdown="span" class="alert alert-info">:information_source:
**Note:**
- `find` searches by full strings and not substrings.
- You may only search for a few attributes.
- Only one attribute can be searched at one time.
**Note:** `find` searches by full strings and not substrings. The search will only be carried out for **one** given
attribute.
</div>

<div markdown="span" class="alert alert-info">:information_source:
* The search is case-insensitive. e.g panadol will match pANAdol.
* The order of the keywords does matter. e.g. "panadol" will match "medicine panadol".
</div>

Format: `find (n/NAME | i/NRIC | t/TAG | ad/DOCTOR | m/MEDICINE ) [MORE_KEYWORDS]`

* The search will only be carried out for the given attribute.
* The search is case-insensitive. e.g panadol will match pANAdol.
* The order of the keywords does matter. e.g. "panadol" will match "medicine panadol".
* Multiple keywords for a given attribute can be inputted. All matching persons will be returned.
* e.g., `find n/David Alex Jon` will return persons with name containing `David` or `Alex` or `Jon` or any
combination of the three.

Examples (The following results are based of the sample data provided):

* `find n/john` returns `John Lim` and `John Doe` who both contain the name `John` in their names.
* `find a/serangoon` returns `Alice Tan` and `John Doe` who have an address located in `Serangoon`.
* `find i/S0078957G` returns `Alice Tan` who has an NRIC of `S0078957G`.
* `find a/ang mo kio serangoon` returns 'Alice Tan', 'John Doe', 'John Lim' who all stay either in `ang mo kio`
or `serangoon`.
* `find t/Diabetic` returns all persons with the tag `Diabetic`.
* `find t/Diabetic Osteoporotic` returns all persons with the tag `Diabetic` or `Osteoporotic` or both.
* `find ad/Shannon` returns all persons with attending doctor `Shannon`

Expand Down