search

shaunngoh / pe

0 stars 0 forks source link

UML diagrams hard to read due to complexity and contrast in colour. #17

Open shaunngoh opened 4 days ago

shaunngoh commented 4 days ago

The colours of the diagram makes it hard to determine the navigability and types of arrow used. Additionally, the latter diagram for command makes it difficult to read due to its complexity.

image.png

nus-se-bot commented 1 day ago

[IMPORTANT!: Please do not edit or reply to this comment using the GitHub UI. You can respond to it using CATcher during the next phase of the PE]

Team's Response

Thank you for the Bug Report. However, looking at our program, this class diagram is actually accurate to what we have in our programs of parser and command. All of these classes are crucial as not highlighting any one of them means there is a missing command, thus none of these classes can be omitted as they are important for future developers. Furthermore, we feel that the diagram's words are actually still legible, thus we feel that this is not an issue. We have trialed with black text and we determined that it is harder to actually read the diagram.

As per the guide for PE in the lecture notes, this we have classified this as VeryLow instead of Low as shown below as it is purely a cosmetic issue:

image.png

Items for the Tester to Verify

:question: Issue response

Team chose [response.NotInScope]

Reason for disagreement: [replace this with your reason]

## :question: Issue severity Team chose [`severity.VeryLow`] Originally [`severity.Low`] - [ ] I disagree **Reason for disagreement:** [replace this with your reason]