nus-pe-script
commented
1 year ago Team's Response
No details provided by team.
The 'Original' Bug
[The team marked this bug as a duplicate of the following bug]
Unopened examples in 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.
Unopened examples. The arrow is non-functional in PDF format.
Must have forgotten to expand all examples, because some of them are opened before converting to PDF. Refer to the image below.
[original: nus-cs2103-AY2223S2/pe-interim#2622] [original labels: severity.Low type.DocumentationBug]
Their Response to the 'Original' Bug
[This is the team's response to the above 'original' bug]
Thanks for pointing that out.
Regarding some duplicates of this issue reporting it as "Medium" severity, here is why we feel it is "Low". The user is likely only inconvenienced by this issue during the first read of the UG. It is also not a huge inconvenience as the user can figure out, without the examples, what each command syntax rule is referring to base on the description and also the examples given for each command. Since a "Medium" severity requires that the issue be an "occasional inconvenience", this issue does not fit that severity.
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 severity Team chose [`severity.Low`] Originally [`severity.Medium`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]
Some examples cannot be seen in the PDF version
Especially for command syntax, which is what users will read before reading any of the commands in detail. This will really inconvenience the user as they may need examples to help with their understanding.