Benson15912 / pe

0 stars 0 forks source link

Sequence Diagrams are not detailed in showing the sequence. #11

Open Benson15912 opened 2 months ago

Benson15912 commented 2 months ago

The sequence diagrams are not detailed in really explaining the code's process and activity. In all commands, the sequence diagrams are the same except for the beginning parameters.

For example, for the add patient sequence diagram:

image.png

What does the args in setPatient(args) represent? One typo here is that setPatient should be addPatient. Diagram is abit too small here too.

What should be added here is that a patient object is created before creating the addCommand as the addCommand requires a Patient in its contructor. Then we can do addPatient(p) as the patient is created.

Another example is editing a patient:

image.png

What should be added here is that an editedPatientDescriptor object is created so that you can setPatient().

DeletePatientDiagram:

image.png

should not be deletePatient(1) should be deletePatient(p) where p is a patient object.

soc-pe-bot commented 2 months ago

Your response not required for this bug as the team has accepted the bug as it is.