nus-se-script
commented
2 months ago Team's Response
No details provided by team.
The 'Original' Bug
[The team marked this bug as a duplicate of the following bug]
Clearance issue in UG examples
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.
It should be indicated in a clearer way that the words in the squared brackets are the actual command and the circled words are outputs from the App. Otherwise the user might confuse the last line as a command.
[original: nus-cs2113-AY2324S2/pe-interim#1554] [original labels: severity.Low type.DocumentationBug]
Their Response to the 'Original' Bug
[This is the team's response to the above 'original' bug]
We accept this issue, but have decided to lower it to verylow severity since it is only a cosmetic issue.
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]
the example of usage shows 3 separate command and only a single output and could be confusing at first glance. Furthermore, an added tab for outputs to differentiate from the command inputs may not suffice to provide the clarity needed