soc-pe-bot
commented
2 years ago Team's Response
No details provided by team.
The 'Original' Bug
[The team marked this bug as a duplicate of the following bug]
Overly long diagram in DG pages 19-20
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.
The sequence diagram explaining how the timetable is printed out in pages 19-20 of the DG spans a page break, and its length can hinder readability. Consider splitting it up into parts, and maybe omitting parameters from the method calls shown?
[original: nus-cs2113-AY2122S2/pe-interim#1239] [original labels: severity.Low type.DocumentationBug]
Their Response to the 'Original' Bug
[This is the team's response to the above 'original' bug]
Overly long diagram may hinder readability, but the diagram itself should still be a singular diagram without being divided in two to retain the logic it is conveying.
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]
The image had to be span across 2 pages due to all the parameters of the method calls which could be omitted for brevity. This makes the sequence diagram difficult to read and hard to understand what exactly is important and what is not.