search

Yukun99 / pe

0 stars 0 forks source link

Inaccurate Ui Sequence Diagram #7

Open Yukun99 opened 2 years ago

Yukun99 commented 2 years ago

In the sequence diagram under UI component, the setFeedBackToUser(result) method callback should not be taking in a result, but should instead be taking in the userFeedBack. Given that adding a command to the application is one of the more common things that developers will engage in, I believe that this could be of medium severity due to the frequency of the issue appearing. However, developers following the guide will likely just have to deal with errors when inputting the wrong parameter type into the function call, and will ultimately find out the fix by looking at the source code of the original project, thus it should still allow them to continue development.

image.png

nus-pe-bot commented 2 years ago

Team's Response

Although it would have been better if the parameter for setFeedBacktoUser is "feedBack" instead of "result", this shouldn't be a problem for the developers since the UML diagram is supposed to serve as a guide, and doesn't have to reflect the exact parameter or parameter type taken in the code. So, we believe the severity should be low instead.

Items for the Tester to Verify

:question: Issue severity

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

Reason for disagreement: The diagram is meant to serve as a guide, which I agree with. However, it is the only guide in the whole document that pertains to this feature. This means that whoever refers to this will get sent down the wrong path with no other reference until he looks into the original source code, which is way less easily read for developers. Since the developer will face an error when facing the exact diagram shown in the DG, I believe this is Medium severity due to how likely it is for future developers to add new commands.