search

LuYiting0913 / pe

0 stars 0 forks source link

UML diagram not accurate #14

Open LuYiting0913 opened 1 year ago

LuYiting0913 commented 1 year ago

image.png

delete_person(1) should be delete contact(1). inconsistency or error?

nus-pe-bot commented 1 year ago

Team's Response

Assuming that this is referred to the label of the Model interface function call, there is no such deleteContact() function in the Model interface, only deletePerson(). Therefore, this model sequence diagram is accurate.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: agree that the diagram may be accurate.

but it is still inconsistent with the naming. there should be a deleteContact method in model to match the behaviour. there is no explicit mention in the DG that person and contact are interchangeable as well.

Moreover, deleting a contact may require extra action compared to deleting a person. this is also not a good SE practice.

the inconsistency can also 'hinder' the reader in the sense it requires the reader to put more effort than necessary to make sense of the relationship between person and contact.