ruoyann / pe

0 stars 0 forks source link

Commands in sequence diagrams should be destroyed #19

Open ruoyann opened 3 years ago

ruoyann commented 3 years ago

This applies to all commands in all sequence diagrams. Some examples are below:

d:DeleteCommand

image.png

tabCommand

image.png

nus-pe-bot commented 3 years ago

Team's Response

Object deletion is optional according to the module website as shown in the screenshot below:

image.png

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: If the team really wanted to make object deletion optional, the team should have been consistent and omitted all object deletions instead of selectively keeping some and not showing some. This inconsistency can confuse the readers.


:question: Issue severity

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

Reason for disagreement: Definition for veryLow severity: "severity.VeryLow : A flaw that is purely cosmetic and does not affect usage e.g., a typo/spacing/layout/color/font issues in the docs or the UI that doesn't affect usage. Only cosmetic problems should have this label."

This is not purely cosmetic as it can hinder the understanding of developers reading the sequence diagrams due to inconsistent object deletion.