search

Kobot7 / pe

0 stars 0 forks source link

"Interacting with Environment Component" Sequence diagram: Return arrow should be dotted line #12

Open Kobot7 opened 2 months ago

Kobot7 commented 2 months ago

Problem

The sequence diagram for Interacting with Environment Component uses a solid line instead of dotted line for return value. This is incorrect notation.

image.png

nus-pe-bot commented 2 months ago

Team's Response

This notation error does not hurt the credibility of the diagram.

Items for the Tester to Verify

:question: Issue response

Team chose [response.NotInScope]

Reason for disagreement: Hi team, I've noted the team's stance that the notation error does not hurt the credibility of the diagram. However, I feel otherwise and would like to offer more insight as to why.

Solid lines are used to indicate a call to a method. Using solid lines to indicate a return is a direct violation of standard notation. If we choose to accept the usage of solid lines for returns, how can the user be sure that the rest of the diagram's solid lines are for method calls? Hence, this hurts the credibility of the diagram.

Lastly, the screenshot below is from the CS2113 website. If "using dashed line where a solid line should be used" is considered an valid bug, I believe that the converse "using solid line where a dashes line should be used" should be considered a valid bug as well.

image.png

The team has marked the bug as response.NotInScope, which indicates that the team acknowledges that "it is a valid issue but not something the team should be penalized for". Since the team agrees that it is a valid issue, I am unclear as to why the team feels that they should not be penalized for it. Perhaps you could help to shed some light in regards to this? Thanks!

Best Regards, One of your team's PE tester