owx0130 / pe

0 stars 0 forks source link

missing ":" in sequence diagram #19

Open owx0130 opened 3 months ago

owx0130 commented 3 months ago

image.png

none of the labels have a ":" to indicate they are objects. If class-level methods are being called, the label <<class>> should be used, which is not being used here.

almost every other sequence diagram has this issue, hence the severity level of medium was given

nus-se-bot commented 2 months ago

Team's Response

Those are in fact not objects, but rather classes. Regardless, the ability of the reader to understand the sequence is not hindered.

Items for the Tester to Verify

:question: Issue severity

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

Reason for disagreement: i disagree with the team's response, as i believe the user's ability to understand the diagram is in fact hindered by omitting the : or <<class>> labels. due to this bug, the user is left confused here as to whether the commands being called are class-level methods or not, which impacts how they interpret the implementation of the feature. the team mentioned that the participants are in fact classes, so the <<class>> label should have been used to label all of them to prevent any confusion to the reader.

there is a non-trivial impact on the user's ability to interpret this diagram, which justifies the severity level of medium for this bug.