search

T-Wan-Lin / pe

0 stars 0 forks source link

Necessity for Ui Class Diagram #17

Open T-Wan-Lin opened 1 year ago

T-Wan-Lin commented 1 year ago

Screenshot 2023-04-14 at 5.52.49 PM.png

Is a class diagram for Ui necessary? It is rather long and would get outdated quickly (if you were to update it), given the many methods you have. The sequence diagram for Ui is much more meaningful in the DG

soc-pe-bot commented 1 year ago

Team's Response

Thank you for the suggestion, but we think that it is more useful for developers to have a glance at the UI methods that are used extensively throughout the program. Moreover, UML formatting is followed for the developer to understand the diagram.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: As per the module website:

Screenshot 2023-04-18 at 11.28.02 PM.png

In the Ui Class diagram, there are many exception message print methods, you could have selected those that were more representative of the class which aids in your explanation of what the Ui class does. This logic applies to the rest of the messages. Furthermore, developers usually have access to the source code, so it would not be necessary to showcase everything in the DG as they can cross-reference to the source code.