search

ysl-28 / pe

0 stars 0 forks source link

Unnecessary details in sequence diagrams #14

Open ysl-28 opened 1 year ago

ysl-28 commented 1 year ago

It seems unnecessary to specify when the line separators ______ are printed in the sequence diagram as they are not related to the actual command and are for purely cosmetic purposes.

seq_diagram_borderline.PNG

nus-se-bot commented 1 year ago

Team's Response

We agree that it might seem a little unnecessary but we felt that it would be good to include this in to show the actual method calls.

Items for the Tester to Verify

:question: Issue severity

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

Reason for disagreement: Showing when the line separators are called in one's sequence diagram appears to be introducing unnecessary details to the sequence diagram that does not contribute to the reader's understanding of the flow of the program.

Furthermore, choosing to include those possibly-unnecessary details could distract developers who are using the sequence diagram to understand the flow of the program, and perhaps some other function calls that are more relevant to the functionality of the program could have been included in its place. This represents a small inconvenience to the reader and thus is a bug of Low severity.