javinchua / pe

0 stars 0 forks source link

Return value not specified in UML #11

Open javinchua opened 9 months ago

javinchua commented 9 months ago

image.png After the creation of the CalculateMcCommand and the CommandResult object, the object names of c and result should have been returned respectively in the immediate return arrow but it is omitted and only shown in the following return arrow.

nus-se-script commented 9 months ago

Team's Response

Thanks for raising this up!

Since it is obvious that the object that was just created is being returned, the omission of explicitly stating it is allowed. It is clear since the object was just initialized by the method calling it.

You can refer to this diagram from the textbook:

image.png

We feel that the severity should be VeryLow, since this is just a slight cosmetic issue, unimportant to user understanding.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: While it is true that the return object is optional, your current diagram is still inconsistent with the rest of the sequence diagrams in the DG, which can cause some confusion as to why the return object is indicated in some cases but omitted in this one. To ensure clearer understanding, it is vital that sequence diagrams have consistency. I have attached below some screenshots of sequence diagrams from other parts of your DG.

image.png

image.png

image.png


## :question: Issue severity Team chose [`severity.VeryLow`] Originally [`severity.Low`] - [x] I disagree **Reason for disagreement:** [replace this with your reason]While it is true that the return object is optional, your current diagram is still inconsistent with the rest of the sequence diagrams in the DG, which can cause some confusion as to why the return object is indicated in some cases but omitted in this one. To ensure clearer understanding, it is vital that sequence diagrams have consistency. I have attached below some screenshots of sequence diagrams from other parts of your DG. ![image.png](https://raw.githubusercontent.com/javinchua/pe/main/files/fe0f9ff4-527e-4733-b931-29a8c264cafe.png) ![image.png](https://raw.githubusercontent.com/javinchua/pe/main/files/6fb6ba7c-2293-4a45-a637-c0e9d5040719.png) ![image.png](https://raw.githubusercontent.com/javinchua/pe/main/files/876b235b-7030-4842-8cab-fa2d6a826139.png)