nus-pe-script
commented
2 years ago Team's Response
While it is a fair point, it is a purely cosmetic issue and should not affect readability
The 'Original' Bug
[The team marked this bug as a duplicate of the following bug]
Large chunks of white spaces in UG and DG.
Note from the teaching team: This bug was reported during the Part II (Evaluating Documents) stage of the PE. You may reject this bug if it is not related to the quality of documentation.
Pages such as page 13 of DG and page 4 of UG.
[original: nus-cs2103-AY2122S2/pe-interim#571] [original labels: severity.VeryLow type.DocumentationBug]
Their Response to the 'Original' Bug
[This is the team's response to the above 'original' bug]
The large chunks of white space are to improve readability by clearly sectioning different sections of the UG and DG.
Items for the Tester to Verify
:question: Issue duplicate status
Team chose to mark this issue as a duplicate of another issue (as explained in the Team's response above)
- [ ] I disagree
Reason for disagreement: [replace this with your explanation]
:question: Issue response
Team chose [response.Rejected]
- [x] I disagree
Reason for disagreement: This is evidently an issue that hinders the reader (affects readability) and thus qualifies as a documentation bug, albeit with a very low severity. Readers may likely be confused and therefore distracted to find the diagram relevant to the sample input located in a separate page for no valid reason.
https://nus-cs2103-ay2122s2.github.io/website/admin/tp-pe.html#documentation-bugs-5
The expected output as given by sample input 2 in
sortClientsis presented on a completely separate page. There appears to be sufficient space below the sample command, yet this space is not utlilised and hinders the reader.