UML Diagram inconsistency and typo.

[Pinran-J]

Description:

Uml diagrams are provided for certain implementations in DG.

Bug found:

Multiple UML diagrams reference FilteredList in Model. However, there are inconsistencies with how FilteredList is referenced and displayed. (different coloured activation bars)

This inconsistency is seen on other UML diagrams too.

Screenshots:

Example : (red boxes and no name for FilteredList) (Alias)

White boxes and a FilteredList called :fs? (Find)

[nus-se-bot]

Team's Response

Duplicate of issue #3461.

Same issue, different colours used in diagrams.

The 'Original' Bug

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

Colour of arrows not standardised

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.

---

this picture arrow colour follows class name, but the other does not.

---

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

Their Response to the 'Original' Bug

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

Even if it is not consistent, the diagrams themselves are correct and readable. There is no requirement for standardization between diagrams.

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)

• [ ] I disagree

Reason for disagreement: [replace this with your explanation]

---

:question: Issue response

Team chose [response.Rejected]

• [x] I disagree

Reason for disagreement: The team argued that the diagrams are correct and "readable" and that there is no requirement for standardization between diagrams.

However, the difference in

• Colour of activation bar
• Colour of operation lines
• Other naming/font inconsistencies

all account for very very inconsistent sequence diagrams and should be a basic to standardize these diagrams to avoid confusion.

Althought the diagrams are "readable", these differences across the diagrams (jumping from coloured to non-coloured and back to coloured) will hinder readers, cause confusion and slow the readers down.

This is because readers will be left wondering what these differences(colours/naming) in the diagrams mean which might also mislead the readers into thinking the coloured notations have special meanings even though the team might not mean for it to have special meaning.

---

:question: Issue severity

Team chose [severity.VeryLow] Originally [severity.Medium]

• [x] I disagree

Reason for disagreement: As explained in the Issue response, this bug is no longer just a cosmetic issue that warrants a severity.VeryLow as it both hinders and mislead the readers. This should be at the very least a severity.Low.

However, since the inconsistency is across all sequence diagrams, it does not appear in "very rare situations" but "occasional", therefore warrants a severity.Medium

---