search

nus-cs2103-AY2021S2 / pe-dev-response

0 stars 0 forks source link

GUI Description cannot be found #3147

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 User Guide mentions annotations of the GUI description, but only the name of the GUI section can be found and the names don't really explicitly explain the usage of the GUI component. Marking this as Low even though users might not understand the component usages due to potential different interpretations of the word description.

image.png

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

Winniehyx commented 3 years ago

Team's Response

Dear responder, thank you for highlighting this issue. However, we do not see an issue with using the word description. We are not sure what you mean by "potential different interpretations of the word description". For instance, result display just means display of result and command box just means box where you type your command. My group feel that adding in definition for every single word is not possible as it would make the UG unnecessarily long which is a bug as well. We could understand it if the word description has more than one meaning but in this case, we felt that it was straight forward as to what each description meant.

The different features featured in the UI are further elaborated in other sections as well.

Duplicate status (if any):

--