search

nus-cs2113-AY2021S1 / pe-dev-response

0 stars 0 forks source link

Vague description in User Guide #1545

Open nus-pe-bot opened 3 years ago

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

The language used in this section is rather confusing, and the user would not know what "these three" are referring to at that point. Also, the capitalisation is inconsistent in example usage

image.png

[original: nus-cs2113-AY2021S1/pe-interim#1396]

yuqiaoluolong commented 3 years ago

Team's Response

Firstly, "these three" (of should be "these three nutrition elements") would refer to carbohydrate, protein, and fat, which was mentioned in the same sentence shown in the picture: "When user adds foods without carbohydrate, protein, and fat, the amount of these three nutrition elements would be recalculated ... " This seems not confusing if the user read the UG clearly.

Secondly, the capitalisation is consistent in example usage. no matter "calculate" or "carbohydrate", their capital letters are always in lower cases in the part of UG shown in the picture.

Duplicate status (if any):

--