nus-pe-bot
commented
3 years ago Team's Response
Hi, thanks for the feedback. However, we felt that each of the examples is not redundant as each of the examples returns a different result and is meant to show something different. Hence, we see it as a way for us to take the extra mile in ensuring that our readers understand the command better.
Items for the Tester to Verify
:question: Issue response
Team chose [response.Rejected]
- [x] I disagree
Reason for disagreement: Similar to my issue raised on cluttered UG, i think this is still highly relevant as repetitive examples are considered as bugs in the UG as it hinders readers. I appreciate the comprehensiveness of the UG but because of this, the UG becomes a bit too long and not very comprehensible. Thus, i think that this should be a relevant issue that should be considered.
As a reader, i like how the user guide is very detailed but for a reader reading this User guide for the first time, i am very overwhelmed by the number of features and examples. I think some of the examples may be abit repetitive and can be left out. For example, under the find_student command, examples were given for two cases of providing one keyword and multiple keywords. Each of these examples then include a few example inputs. I think this may not be too necessary since the expected outcomes have already been specified above.