search

APZH / pe

0 stars 0 forks source link

Game Component Class Diagram - Incorrect use of labelling of relationships #15

Open APZH opened 2 years ago

APZH commented 2 years ago

image.png

As underlined in the image above, according to the UML drawing standards mentioned in class, when labelling relationships between 2 entities, a solid triangle should be used instead of "<>" as shown in the image below, that was taken from the module website.

image.png

nus-se-script commented 2 years ago

Team's Response

Hi, Thank you for your advice.

The 'Original' Bug

[The team marked this bug as a duplicate of the following bug]

Class diagram does not adhere to standard notation

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.

image.png

Perhaps the labels in the round circles could have been disabled in plantUML?

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

Their Response to the 'Original' Bug

[This is the team's response to the above 'original' bug]

Hi, Thank you for your advice. will do.

Items for the Tester to Verify

:question: Issue duplicate status

Team chose to mark this issue as a duplicate of another issue (as explained in the Team's response above)

Reason for disagreement: [replace this with your explanation]

:question: Issue severity

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

Reason for disagreement: The lack of the proper label with the solid triangle, developers reading the DG may be confused on the direction the label should be read, which my in-turn result in the wrong interpretation on the relationships between the various classes.