nus-pe-bot
commented
2 years ago Team's Response
The UG clearly states in the pointer that at least 1 prefix must be provided. The UG description for Show command is correct.
To address your concern for our command format, it is a design consideration to not include a separate command formatting as we feel that no form of command formatting could reasonably capture such a usage as well as simply providing a clear written pointer as shown above.
Furthermore, including a separate command format would make the UG even more complicated for the reader. We have also considered that such a usage is not so commonly used by our features as to warrant an entirely new text formatting for it, especially when a text pointer would be more appropriate.
Therefore, we will be rejecting this issue.
Items for the Tester to Verify
:question: Issue response
Team chose [response.Rejected]
- [x] I disagree
Reason for disagreement: Hi, good point about the note. I failed to notice it during the stress of PE and thus that is on me. However, the command format is still somewhat misleading, even though it is just a purely cosmetic issue with the pointer.
:question: Issue severity
Team chose [severity.VeryLow]
Originally [severity.Medium]
- [ ] I disagree
Reason for disagreement: [replace this with your explanation]
The command format for show suggests that all parameters are optional,
but that is not the case in app, as exactly one prefix is required.
Why I felt that this is a medium severity bug is because the command format is completely wrong, as it also suggests you can have multiple prefixes per show command, which you can't. While the pointer below does help to clarify that, the shown command format is still a bad choice.