Bubbl3T / pe

0 stars 0 forks source link

Incorrect architecture diagram in DG. #9

Open Bubbl3T opened 1 year ago

Bubbl3T commented 1 year ago

In the DG, the architecture diagram only contains the StageManager class, but shows that no other components are interacting with it. However, in the sequence diagram below, we can see that the Logic class calls on the StageManager class. Perhaps arrows could have been added to the architecture diagram to show that Logic will try to access StageManager.

nus-pe-bot commented 1 year ago

Team's Response

StageManager is a singleton, so every class will have an arrow to StageManager, and we deliberately omitted that since it would clutter the diagram. We intended for the developer to understand that a singleton would be accessible by every class. However, we did not explicitly state this.

Items for the Tester to Verify

:question: Issue severity

Team chose [severity.Low] Originally [severity.Medium]

Reason for disagreement: [replace this with your explanation]