tau-bar / pe

0 stars 0 forks source link

Missing arrow in class diagram. #19

Open tau-bar opened 2 years ago

tau-bar commented 2 years ago

Expected:

• Expected Behaviour: Arrow pointing to Patient class, since it is stated that Appointment has a reference to a Patient class.

Actual:

• Actual Behaviour: No arrow.

• Why that severity? Low, as this is a mistake in the UML documentation, may cause developers some confusion as to whether description is right.

Steps to reproduce:

  1. Go to How Appointment is implemented section

Screenshots:

Screenshot 2021-11-12 at 5.31.15 PM.png

In comparison, from another section:

image.png

nus-pe-bot commented 2 years ago

Team's Response

No details provided by team.

Items for the Tester to Verify

:question: Issue severity

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

Reason for disagreement: ### Response

Disagree. This is not a deliberate decision to omit details, as in other sections the arrow is present, neither is it a mere cosmetic issue. This is an oversight by the writers of the DG.

Rationale

  1. As stated by the module website, "omitting details from a diagram is OK if it does not mislead/hinder the reader". In this case, it may hinder the reader, who just saw the diagram with no arrow, and then read a description that is contradictory to the diagram shown. This could cause the reader hindrance as they would have to scour the DG again in order to check whether there was supposed to be an arrow there, or whether the description below the diagram is wrong.

  2. This is not a mere cosmetic bug which has no repercussions on the reader. If the word 'Model' was misspelt as 'Modl', perhaps this would be a severity.VeryLow. However, this bug has potential to cause actual inconvenience to the developers reading this DG, as explained above. As specified by the module website, a severity.Low bug is one that causes a minor inconvenience to the reader. Therefore, this is a severity.Low bug.

Screenshots

image.png

Screenshot 2021-11-17 at 7.27.20 PM.png