search

WM71811 / pe

0 stars 0 forks source link

DG logic diagram error #13

Open WM71811 opened 3 years ago

WM71811 commented 3 years ago

Logic interface should have a dependency arrow pointing to CommandResult? Like this Screenshot 2020-11-13 at 5.22.56 PM.png

But you diagram does not have this arrow

nus-se-bot commented 3 years ago

Team's Response

Thank you for the bug report.

Firstly, we will reduce the severity to Low instead of Medium. This is because it does not affect the information that is meant to be conveyed with the usage of this Class Diagram (Refer to explanation below the image).

image.png

Secondly, we will be rejecting this bug due to reasons explained below.

Strictly speaking, the Logic interface indeed has a dependency on CommandResult. However, since our diagram is much more complicated, we decided to omit this as adding the additional arrow will make the diagram more cluttered and much harder to read.

The focus of this diagram is to show the interactions of the classes within the logic component itself, and we decided to emphasize the interactions in the Parser, Command and Parameter, over how the logic component interacts with other components through its interface.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: Thank you for the reply.

I would disagree with the team's response of rejection because a UML diagram should show the necessary information to improve the reader's understanding.

I think that "intentionally omitting" the dependency arrow does not improve the readability of the diagram greatly, since it is only one arrow that is missing, and it would occupy a very small part of the diagram since the Logic interface and theCommandResult class are not far apart. I think that adding this one arrow is not so likely to make the diagram "much harder to read", but would help with the reader's understanding of the existance of a relationship between the Logic interface and theCommandResult class.

I also would believe that rejecting this bug report may mean that the team does not think that the dependency arrow should be there. However, it is true that there is a dependency relationship between the 2 parties already displayed in the Logic diagram, and showing the dependecy would be helpful to allow the developers who read the DG to understand the relationships and interactions better, so I feel that the bug report should not be rejected.

:question: Issue severity

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

Reason for disagreement: [replace this with your explanation]