soc-se-bot
commented
2 years ago Team's Response
I think this is very subjective.
This line clearly explains the order for formatting.
These lines shows that it is possible to do 1 parameter only
These show that it is possible to do 2 parameters with order.
Reason as to why not more was added for 2, was that following the above examples, it is easy to understand how a command should be. More examples would make the already length format subsection more lengthy and would not add much value to it overall.
Reason for choosing that specific 2 parameter example, the /from parameter would be the least used example as it is a high chance to be your home country, thus the 2 most used parameters were chosen instead.
Items for the Tester to Verify
:question: Issue response
Team chose [response.Rejected]
- [ ] 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]
In this case, for an extremely crucial feature such as this, I think it makes sense to include perhaps one or two more examples. My reasoning is that due to the complex nature of this command (a lot of parameters and spaces to follow) it is quite possible for the user to make mistakes when they try it out. So, examples will go a long way in improving their experience.