soc-pe-bot
commented
12 months ago Team's Response
One example is sufficient to show how the commands work as the commands are relatively simple and the optional fields are quite intuitive. Even without an example, users can understand how the commands work well. We also kept to one example as we did not want to clutter up the UG, and for those commands with optional fields, we have already made it a point to explain the "optionalness" of the command.
Items for the Tester to Verify
:question: Issue response
Team chose [response.Rejected]
- [x] I disagree
Reason for disagreement: As seen in the screenshot below from the course website, the lack of examples is considered a bug. Although i do agree that adding too many will clutter the UG, an example showing the optional nature of fields is not redundant especially for users who skip to images or users who wish to try out example commands.
By your argument, no example would be needed at all since the command format is already explained.
Most if not all features only have 1 example and all of them are positive examples. For certain features that have optional fields, it might be better to have more examples showing the "optionalness" of those fields.