nus-cs2103-AY2324S1 / pe-dev-response

0 stars 0 forks source link

Sequence diagram for interaction within logic component #1793

Open nus-se-script opened 10 months ago

nus-se-script commented 10 months ago

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.


image.png

image.png

In the example given for execute("deleteE 1"), there are missing calls to the model for getTaskHub and updateFilteredProjectList.


[original: nus-cs2103-AY2324S1/pe-interim#2571] [original labels: severity.Low type.DocumentationBug]

rayyan35p commented 10 months ago

Team's Response

We will be rejecting this issue because we chose to intentionally omit the calls from the sequence diagram as they are not very important to the explanation of the command.

We believed that the deletion of the employee was the most important detail that had to be included and the aforementioned calls were not important to the reader understanding how deletion itself works.

See related note:

image.png

While we did include the calls in other sequence diagrams, we also recognised that adding more details to this sequence diagram may cause additional clutter, further adding on to the reason as to why we omitted the calls.

Duplicate status (if any):

--