Sequence Diagrams are not detailed in showing the sequence.

[nus-se-script]

Note from the teaching team: This bug was reported during the Part II (Evaluating Documents) stage of the PE. You may reject this bug if it is not related to the quality of documentation.

---

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:

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:

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

DeletePatientDiagram:

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

---

_{[original: nus-cs2103-AY2324S2/pe-interim#1405] [original labels: type.DocumentationBug severity.VeryLow]}

[choowengyan]

Team's Response

thanks for pointing it out!

Duplicate status (if any):

--