nichyjt / pe

0 stars 0 forks source link

DG - TrigoGraph sequence diagrams that should return values have no return line #16

Open nichyjt opened 1 year ago

nichyjt commented 1 year ago

Description

Most function calls do not return a value with the dotted arrow. Minimally, this might be fine, but in this case the addition of the return dotted arrow to the diagram is important as actual non-void values are being returned.

This is important as the return values can be named, such as amplitude from getAmplitude. This helps the developer reading understand where certain names come from, such as the function call later to printAmplitude.

Further, the use of the dotted line is inconsistent, with only constructors having the return line.

image.png

nus-se-script commented 1 year ago

Team's Response

No details provided by team.

Items for the Tester to Verify

:question: Issue response

Team chose [response.NotInScope]

Reason for disagreement: The team did not justify why this is not in scope.

My arguments still stand regarding the loss in relevant information and why the return values are essential for the user to understand the diagram:

in this case the addition of the return dotted arrow to the diagram is important as actual non-void values are being returned. This is important as the return values can be named, such as amplitude from getAmplitude. This helps the developer reading understand where certain names come from, such as the function call later to printAmplitude.

From the textbook:

optional elements (e.g, activation bars, return arrows) may be omitted if the omission does not result in ambiguities or loss of relevant information

Essentially, I think that these function calls return something and the return line + variable name is important information that will help the reader better understand the diagram.