Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

GUI Description cannot be found #3147

Open
nus-pe-bot opened this issue Apr 16, 2021 · 1 comment
Open

GUI Description cannot be found #3147

nus-pe-bot opened this issue Apr 16, 2021 · 1 comment

Comments

@nus-pe-bot
Copy link

nus-pe-bot commented Apr 16, 2021

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
Copy link
Contributor

Winniehyx commented Apr 17, 2021

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):

--

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants