search

nus-cs2103-AY2324S2 / pe-dev-response

0 stars 0 forks source link

Unintuitive explanation provided in the findt section #2112

Open nus-se-script opened 7 months ago

nus-se-script commented 7 months ago

Note from the teaching team: This bug was reported during the Part II (Evaluating Documents) stage of the PE. You may reject this bug if it is not related to the quality of documentation.

Actual

The statement: "Patients matching at least one keyword will be returned. e.g. depression diabetes will return depression wheelchair and diabetes tumour ."

This statement is unclear in its meaning. Ideally, the explanation should specify that the words that are being matched are words within the tags. Then, it isn't clear what "return depression wheelchair and diabetes tumour" actually means since the application doesn't return the tags themselves, but instead the patients with those tags. Perhaps it could be rephrased as: "will return patients with tags such as depression wheelchair and diabetes tumour" instead.

image.png

[original: nus-cs2103-AY2324S2/pe-interim#2683] [original labels: severity.Low type.DocumentationBug]

guohuang88 commented 6 months ago

Team's Response

Hi! Thanks for pointing it out!

Duplicate status (if any):

--