Skip to content

Commit cbacb66

Browse files
authored
Merge pull request #214 from alex-setyawan/message-issues
Fix cluster command error message and some of user guide
2 parents 20b2dfe + 8ac6af3 commit cbacb66

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

docs/UserGuide.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -262,7 +262,7 @@ Common mistakes:
262262

263263
### Cluster finding : `cluster`
264264

265-
Finds cluster in location specified.
265+
Provided an integer, location, and illness, returns whether or not the number of people unwell with that illness (diagnosis in profile) in that area is at least that integer, and lists those people.
266266

267267
Format: `cluster [CLUSTER SIZE] a/[LOCATION] d/[DIAGNOSIS]`
268268

@@ -272,9 +272,9 @@ Format: `cluster [CLUSTER SIZE] a/[LOCATION] d/[DIAGNOSIS]`
272272
* Cluster size must be between 1 and 2,000,000,000.
273273
* Partial words will be matched e.g. `Clem` will match `Clementi`, `deng` will match `dengue`.
274274

275-
Example:
275+
Example:
276276
* `cluster 3 a/Serangoon d/dengue`
277-
* Finds dengue clusters of at least 3 patients in the Serangoon vicinity.
277+
* Finds dengue clusters of at least 3 in locations with the substring "Serangoon".
278278
Common mistakes:
279279
* `cluster 3 a/S d/dengue` (address should be a meaningful word indicative of location in Singapore)
280280
* `cluster 3 a/Serangoon` (diagnosis must be provided)
@@ -363,7 +363,7 @@ ICA guidelines. If your name has any special characters, kindly input a valid na
363363
| **Delete Information** | `deleteinfo <NRIC> <Field>` <br> e.g., `deleteinfo S1234567A e/` |
364364
| **Add Visit** | `addvisit ic/<NRIC> dov/<Date_of_Visit> sym/<Symptoms> d/<Diagnosis> st/<Status>` <br> e.g., `addvisit ic/S1234567A dov/2024-01-01 sym/Cough d/Covid st/UNWELL` |
365365
| **Check** | `check <NRIC>` <br> e.g., `check S1234567A` |
366-
| **Find Cluster** | `cluster <cluster size> a/<Location> d/diagnosis` <br> e.g. `cluster a/Serangoon d/dengue` |
366+
| **Find Cluster** | `cluster <cluster size> a/<Location> d/diagnosis` <br> e.g. `cluster 3 a/Serangoon d/dengue` |
367367
| **Clear** | `clear` |
368368
| **List** | `list` |
369369
| **Help** | `help` |

0 commit comments

Comments
 (0)