search

nus-cs2103-AY2324S2 / pe-dev-response

0 stars 0 forks source link

Vague explanation in user guide for illness input #4561

Open nus-pe-bot opened 6 months ago

nus-pe-bot commented 6 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.

Below is a screenshot of your user guide:

image.png

Expected / Possible Improvements: According to the user guide, I should be able to type in edit 1 I/me since this illness corresponds to a valid name. However, the user guide did not state that it should only correspond to a single category.

Being clearer can ensure that your reader / user will not be confused and type in the wrong input.

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

jmsandiegoo commented 6 months ago

Team's Response

Though might be unclear, the user guide states "... as long it corresponds to a valid name for convenience" which states that it should only reflect to a single category. Though, we also understand that it is easily missed hence we would definitely improve the phrasing in future releases. NotInScope

Duplicate status (if any):

--