search

nus-cs2113-AY2122S1 / pe-dev-response

0 stars 0 forks source link

Excessively complicated `Show Timetable` and `Checking Pre-requisite` Sequence Diagrams #1135

Open nus-se-bot opened 2 years ago

nus-se-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.

Expected: For a sequence diagram with so many steps, ref blocks should have been used.

Actual: Everything in done within one sequence diagram for Show Timetable and Checking Pre-requisite

Show Timetable

image.png

Checking pre-requisite

image.png

[original: nus-cs2113-AY2122S1/pe-interim#1102] [original labels: severity.Medium type.DocumentationBug]

adricpjw commented 2 years ago

Team's Response

Downgrade of severity:
The Checking Prerequisite sequence diagram is admittedly execessively complicated, but the team feels that the Show Timetable sequence diagram is adequately readable and rather understandable.

Duplicate status (if any):

--