nus-pe-script
commented
2 months ago Team's Response
The command summary is not meant to be copy and pasted. It is only meant for the users to read and adapt their commands accordingly in the CLI. Furthermore, even if is is meant to be copy and pasted, the user is expected to cater to line breaks.
Readability wise, user is expected to use a PDF reader to read the UG, thus the start of next page should be visible in the same screen as the end of the current page (like how you screenshotted it). Thus, we believe it does not affect readability as well.
Thus, this is purely a cosmetic issue, and we believe that the severity of this is VeryLow. We reject this because this does not pose any inconvenience to the user.
Items for the Tester to Verify
:question: Issue response
Team chose [response.Rejected]
- [x] I disagree
Reason for disagreement: It is still a cosmetic issue that hinders readers since the portion affected is within the same command, and disrupts the readability of the example code block. Especially since it separates the description field into 2, which might make it harder for users to follow.
## :question: Issue severity Team chose [`severity.VeryLow`] Originally [`severity.Low`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]
Command summary table is separated across pages which affects readability for readers. Especially because the description is within the same command, and disrupts the command format example code block, hence hindering users from convenient copy and pasting.