jylow / pe

0 stars 0 forks source link

Incorrect diagram #11

Open jylow opened 7 months ago

jylow commented 7 months ago

Screenshot 2023-11-17 at 5.37.19 PM.png

This class diagram shows that a record is composed of datetime, condition and medication. Where condition and medication are both *. However, when adding a record, the condition and medication are both necessary fields to be added thus this is an incorrect documentation and provides misleading information to future developers

soc-se-bot commented 7 months ago

Team's Response

No details provided by team.

Items for the Tester to Verify

:question: Issue severity

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

Reason for disagreement: Screenshot 2023-11-21 at 12.42.07 PM.png

The diagram is wrong and hinders the readers understanding of the diagram at question. The diagram affects both the front and backend developers who now assume that I can accept null lists. There is no obvious documentation on whether a null list is allowed or not as it cannot be assumed that all patients have a condition or whether that condition requires medication.

Thus this is not a cosmetic issue and can no way be very low. Also, bug severity is not explicitly defined by the 2103T website but I gave medium on the assumption it causes occasional inconvenience to developers as this is a fundamental diagram and most people would chance upon it.