search

nus-cs2103-AY2324S1 / pe-dev-response

0 stars 0 forks source link

No outgoing actor in sequence diagram #2881

Open nus-se-script opened 8 months ago

nus-se-script commented 8 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

There is no outgoing actor specified in the sequence diagram describing duplicate detection. Hence it is unclear in which scenarios this sequence occurs.

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

AlagappanRa commented 7 months ago

Team's Response

The scenario in which the sequence occurs is stated clearly both in the implementation directly below the diagram and within diagram itself.

  1. Below the diagram (refer to highlighted text):

image.png

  1. Within the diagram, the duplicate company check is originating from the EditCommand class. Where the EditCommand has been invoked from is intentionally left out to avoid over-complicating the diagram and also because it is irrelevant to demonstrating the internals of the duplicate check within the Model component.

Since the term "outgoing actor" is not defined in this course #498, we will assume it to mean that there should be a return arrow pointing away from the EditCommand class. In which case, this arrow is not a must have for a sequence diagram, and has been intentionally left out as mentioned in point 2.

Duplicate status (if any):

--