search

Silvernitro / pe

0 stars 0 forks source link

DG: Model component diagram labels #13

Open Silvernitro opened 3 years ago

Silvernitro commented 3 years ago

Some association labels in the Model component diagram are missing the arrow/direction

Screenshot 2020-11-13 at 5.35.57 PM.png

nus-se-bot commented 3 years ago

Team's Response

The exclusion of arrows is in line with what was done in AB3 model diagrams as you see below. image_2020-11-16_12-23-18.png

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: I agree that association labels like "observable list" are clear even without a direction. However, I feel that the "current project" label can be ambiguous and should include a direction. For example, one could interpret it as the ModelManager having some sort of field to track what the "current project" is. On the other hand, one can also interpret it is a project having some sort of isCurrentProject field that is set to true or false depending on what it "reads" from ModelManager. These are just examples but it already shows that the association can actually be read in both directions with valid assumptions.

As such, I think it'll still be good to include the direction for the association label in this case. I do agree that this severity can be very low.

:question: Issue severity

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

Reason for disagreement: [replace this with your explanation]