nus-se-bot
commented
2 years ago Team's Response
our commands in the UG already said which parameters are compulsory and which can be omitted. the screenshot you have given is a note we have added for the summary table which is very low down UG, hence, it is there to tell the user quiickly which parameters can be omitted without him having to scroll back up. hence we have rejected it.
Items for the Tester to Verify
:question: Issue response
Team chose [response.Rejected]
- [x] I disagree
Reason for disagreement: If this is the case why was the <> icon not mentioned in this portion where the parameters were mentioned to be optional? Something along the lines of "parameters enclosed by <> is optional". Because I thought that <> was included in the commands which led to me mistyping in the CLI. Your formatting even includes the <> without explanation so how would new users know that <> is not included in the command?
:question: Issue severity
Team chose [severity.VeryLow]
Originally [severity.Low]
- [x] I disagree
Reason for disagreement: Very low indicates that this is merely an appearance issue but it clearly causes inconvenience to users. In fact this should be medium as I believe many users would mistake and add "<>" in their commands and causing frequent inconvenience.
The purpose of the <> in the commands were puzzling to me and it is only clarified right at the bottom of the guide the usage of <>. Why would this not be placed in an earlier sections when clarifying commands etc.