search

LMAOboxhack / pe

0 stars 0 forks source link

DG UI and Logic interation class diagram is too complicated #11

Open LMAOboxhack opened 2 years ago

LMAOboxhack commented 2 years ago

Steps to reproduce:

  1. Go to the first class diagram of the 'Restricting Commands based on GUI state' section in the DG.

Expected: Diagram leaves out parts irrelevant to current explanation.

Actual: Diagram includes details that are irrelevant to the current explanation, causing visual clutter and making diagram hard to understand. (e.g. Storage and Model components are not involved in the interaction, so they can be omitted for brevity)

image.png

nus-pe-bot commented 2 years ago

Team's Response

We believe that the addition of the Storage and Model components to the diagram do not cause visual clutter, since they are clearly separated from the Logic component. Furthermore, the interactions with these two components are important for comprehending the command execution.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: I believe this may be classified as a severity.Low bug, since the explanation of the interaction between Logic and UI associated with this diagram in the DG makes no mention of the Storage and Model components at all, so it is not clear what these associations actually represent in the diagram. Furthermore, this diagram is clearly labelled as 'how UI and Logic interact with each other'. Hence, the inclusion of the Storage and Model components & the additional associations here introduces more visual clutter & makes the diagram harder to understand.