nus-pe-bot
commented
3 years ago Team's Response
This was done intentionally. We believe that basic features like this should not require an example as it would further complicate the user guide and make it hard to read.
The 'Original' Bug
[The team marked this bug as a duplicate of the following bug]
[UG] help and exit expected output is not shown in the UG
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.
Not enough visuals e.g., screenshots for expected output for the help and exit command
[original: nus-cs2113-AY2021S2/pe-interim#1286] [original labels: severity.High type.DocumentationBug]
Their Response to the 'Original' Bug
[This is the team's response to the above 'original' bug]
This was done intentionally. We believe that basic features like this should not require an example as it would further complicate the user guide and make it hard to read. (Especially when the output of our help command is very long)
Items for the Tester to Verify
:question: Issue duplicate status
Team chose to mark this issue as a duplicate of another issue (as explained in the Team's response above)
- [ ] I disagree
Reason for disagreement: [replace this with your explanation]
:question: Issue response
Team chose [response.Rejected]
- [x] I disagree
Reason for disagreement: But this can help the user to know what to expect when the app is closed. Remember we have to take it as if the user is inexperienced in these kind of things and they might not know whether the app is closed already etc.
Portion that can be included:
It would be nice to include the output when the user enters the "exit" command when in the dashboard layer. This can help the user to know whether the program has been exited.
Portion that can be included:
Similarly, the output for the "close" command for the module layer can be included as well.