nus-se-script
commented
9 months ago Team's Response
Seeing that this diagram was generated with PlantUML, the position of the arrow labels could not be controlled and hence this is a limitation of PlantUML.
The severity has also been adjusted to very low, since this issue pertains to cosmetics, specifically the spacing of arrows or the potential incorporation of additional colours for clearer differentiation.
Items for the Tester to Verify
:question: Issue response
Team chose [response.Rejected]
- [x] I disagree
Reason for disagreement: Although PlantUML is limited in the placements of arrow labels and the arrows themselves, it is still possible to control these placements to an extent. Additionally, even though PlantUML has these limitations, that does not mean that the bug should be allowed to continue to exist. Instead, it should be taken into consideration that PlantUML is limited in these aspects and instead, the diagram can be split into multiple diagrams to show a more detailed explanation of the structure to ensure that it is not confusing to potential developers. An alternatives to PlantUML can also be considered if developers want to continue putting all these classes into this class diagram. Since this may not be the main focus compared to the rest of the work done up to v1.4, I feel that this bug can be considered NotInScope. However, given that the diagram is decidedly confusing in its current implementation, I do not believe that this bug should be rejected.
## :question: Issue severity Team chose [`severity.VeryLow`] Originally [`severity.Medium`] - [x] I disagree **Reason for disagreement:** > The severity has also been adjusted to very low, since this issue pertains to cosmetics, specifically the spacing of arrows or the potential incorporation of additional colours for clearer differentiation. The UML diagram is not just a cosmetic bug as the diagram is meant to explain the internal structure of the application for other developers. Reading the diagram, it is not clear what filtered and all meant and even though the positioning of arrows and multiplicities are a limitation of PlantUML, it cannot be denied that it is still confusing to developers who wish to continue working on the product, especially with the positioning of the word "all" on one of the arrows since it is unclear which arrow it is meant to be positioned with. A severity of medium was given as it is likely that someone reading this diagram who wishes to work on the product will be confused to some extent. Personally, after reading this diagram, I still had to look through the implementation of the AddressBook and ModelManager to understand the structure that was supposed to be conveyed in this diagram. This is further exacerbated by the fact that the Person object is stored in different ways in three different other objects as attributes in different forms (different kinds of lists). Therefore, I feel that the severity of Medium is appropriate.
The class diagram of the model in the DG is unclear as multiplicities and role labels are placed on the same side of each arrow. This results in the "all" and "filter" roles being potentially misattributed to other arrows or the multiplicity not being clear as it is too far from the arrow.