search

twothicc / pe

0 stars 0 forks source link

Error in UI Class Diagram - [DG] #14

Open twothicc opened 2 years ago

twothicc commented 2 years ago

Your Model Diagram seems to suggest that there is a TabPanel

However, I am unable to find such a class nor fxml file in your repository

image.png

image.png

This can be confusing for developers trying to understand your UI diagram.

nus-pe-script commented 2 years ago

Team's Response

Thank you for your time and effort in writing this bug report.

Accepted, good catch, this is definitely a mistake on our part.

Items for the Tester to Verify

:question: Issue severity

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

Reason for disagreement: This issue describes an error in representing the OOP solution of a major component (UI) of your application. This means that readers are very likely to read this part of your DG and will likely be confused by the inclusion of a non-existent class TabPanel in the class diagram for your UI. They would likely waste time looking through your code only to find that no TabPanel class exists.

image.png

Therefore, this issue would cause occasional inconvenience to readers of your DG. However, the inclusion of a non-existent class in your class diagram for UI would not make the rest of the same class diagram unreadable to your readers, so I believe that a severity of Medium is appropriate.