Activation bar missing for sequence diagram in DG

[darrenangwx]

The activation bar in Module is missing for this sequence diagram

Justification: This is tagged as Low severity as most of the sequence diagrams have activation bars properly indicated

[nus-pe-script]

Team's Response

We omitted this detail to reduce clutter in the diagram as there would be too many activation bars to create.

The 'Original' Bug

[The team marked this bug as a duplicate of the following bug]

Sequence diagrams arrows lack return for methods (editModuleCode)

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 various methods from getModularType() down to getGrade() should have a return arrow to signify the return of the function. The sequence diagram would suggest these methods return nothing which would not be possible as the names of the methods suggest they are getters

---

_{[original: nus-cs2113-AY2223S2/pe-interim#1596] [original labels: severity.Medium type.DocumentationBug]}

Their Response to the 'Original' Bug

[This is the team's response to the above 'original' bug]

According to the CS2113/T website, omitting return arrows if the omission does not result in ambiguities or loss of relevant information and we feel that omitting these actually helps the reader as it makes the diagram neater and reduces unnecessary clutter.

Items for the Tester to Verify

:question: Issue duplicate status

Team chose to mark this issue as a duplicate of another issue (as explained in the Team's response above)

• [x] I disagree

Reason for disagreement: While both issues refers to the same sequence diagram, I would like to clarify that they are, in fact, distinct bugs. The 'original' bug refers to the absence of return methods in the sequence diagram, whereas my bug report addresses the missing activation bars. Hence, I firmly believe that these are 2 separate bugs in the same diagram.

---

## :question: Issue response Team chose [`response.Rejected`] - [x] I disagree **Reason for disagreement:** Based on the screenshot provided, I understand that the activation bars were omitted to reduce clutter. However, I believe it is **crucial to maintain consistency throughout all entities in the diagram from a readers point of view**. Consistency is an essential aspect of any visual representation, as it helps me, as a tester, **quickly understand the information being presented**. In this particular case, the absence of activation bars in the ":Module" component led to my confusion as to why the activation bars was missing and prompted me to raise the issue. Including the activation bars would not only resolve this confusion from a readers point of view, but also improve the overall quality and clarity of the diagram. In conclusion, taking into account the importance of consistency in visual representations from the readers point of view, I disagree with the rejection of this bug.

---

## :question: Issue severity Team chose [`severity.Medium`] Originally [`severity.Low`] - [x] I disagree **Reason for disagreement:** Due to my issue being tagged as duplicate, I firmly believe that the rating of Medium severity is wrong. I believe this change in severity is a mistake on the part of the developers, as I still maintain that the severity of this issue should be considered Low.

---