search

nus-cs2113-AY2122S2 / pe-dev-response

0 stars 0 forks source link

Overly long diagram in DG pages 19-20 #1263

Open nus-pe-bot opened 2 years ago

nus-pe-bot commented 2 years ago

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?

image.png

[original: nus-cs2113-AY2122S2/pe-interim#1239] [original labels: severity.Low type.DocumentationBug]

jltha commented 2 years ago

Team's Response

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.

Duplicate status (if any):

--