AlexanderTanJunAn / pe

0 stars 0 forks source link

Return of Program Control in Sequence Diagram of DG #9

Open AlexanderTanJunAn opened 3 years ago

AlexanderTanJunAn commented 3 years ago

Screenshot 2021-04-16 at 5.26.42 PM.png

Should dotted lines return from :Model and :Storage? Dotted lines representing the return of program control seems to be present for the UI object but not for the other objects.

nus-pe-bot commented 3 years ago

Team's Response

Duplicate of #1304.

The 'Original' Bug

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

Discrepancy in handling void return methods in sequence diagrams

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.


It seems that clear(), save(trackingList) and printReaction(output) all have void return type, but only printReaction(output) has a dotted line back to its caller. While both ways are acceptable, it would be better to standardize how void return methods are handled

Screenshot (259).png


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

Their Response to the 'Original' Bug

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

Even though the printReaction function returns void, it shows output to the user through the command line interface. However, clear() and save(trackingList) functions does not have any outputs to any components. Thus, only printReaction has a dotted line back to the user.

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 response

Team chose [response.Rejected]

Reason for disagreement: While it is true that clear() and save(trackingList) functions do not have any outputs to any components, it would be good to include dotted lines to indicate return of program control. Especially since UI includes them. It would be good to standardise across the whole diagram.


:question: Issue severity

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

Reason for disagreement: [replace this with your explanation]