vevek / pe

0 stars 0 forks source link

Two arrows from XYZCommandParser going to <<interface>>Parser. There should only be 1 arrow. (DG) #9

Open vevek opened 3 years ago

vevek commented 3 years ago

In the DG architecture design section, there are Two arrows from XYZCommandParser to <>Parser. There should only be 1 arrow going from XYZCommandParser to <>Parser.

Screenshot:

Screenshot 2021-04-16 at 15.24.53.png

nus-pe-bot commented 3 years ago

Team's Response

No response provided.

The 'Original' Bug

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

Double implements on same interface?

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.


I am a little bit confused with this double implements of XYZCommandParser on the same Parser interface. I don't think this is a valid UML diagram.

Screenshot 2021-04-16 at 3.25.50 PM.png


[original: nus-cs2103-AY2021S2/pe-interim#1564] [original labels: severity.Low type.DocumentationBug]

Their Response to the 'Original' Bug

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

No response provided.

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)

Reason for disagreement: [replace this with your explanation]


:question: Issue severity

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

Reason for disagreement: I disagree with the team on the severity of this issue. The team changed the severity to low. Whereas I originally chose the severity of medium.

Referencing the definitions of low and medium severity, I believe this is a medium or even a high severity issue.

Firstly, when looking at this diagram, I initially felt "off" about it. However, I doubted myself whether this issue was actually a problem. I took some time to visit the textbook to check whether this was a valid thing to do. This is because the arrows inherently do not have any wrong notations, however, they were used twice in the same context which could have meant something else.

It took me quite some time to determine this, as there are cases where some classes may have more than 1 arrow pointing to another class. Given that it did take me some time to figure out, it posed an inconvenience to me, and I'm sure it inconvenienced other testers as well. AFTER figuring out that this is indeed an error, I was able to continue to use this product.

As testimony that other testers also felt the same way, I would like to highlight another testers words from a bug report that this (my) bug report has been marked as duplicate to. He mentions "I am a little bit confused with this double implements of XYZCommandParser on the same Parser interface. I don’t think this is a valid UML diagram.". I felt the same way indeed, and had to spend precious time during the PE to check the textbook, as I did not want to give a false bug report.

Hence, I believe that this issue is of medium or even possibly high severity, as it affects/confuses/inconveniences most users.