redders7 / pe

0 stars 0 forks source link

Unnecessarily complex sequence diagram for Edit Command #8

Open redders7 opened 2 years ago

redders7 commented 2 years ago

image.png

Excessively complex UML diagram. The alt conditions can be summarised in reference frames. Repeated update commands can also be summarised.

nus-pe-script commented 2 years ago

Team's Response

Documentation bugs are supposed to be set as Very Low. That being said, thank you for the recommendation on reference frames. We will accept this at the lowest severity.

Items for the Tester to Verify

:question: Issue severity

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

Reason for disagreement: Initially reported as severity.Medium, but upon consideration this should be severity.Low. According to the CS2113 guidelines, only cosmetic issues should have severity.veryLow. This issue affects the reader's ability to understand the command's implementation due to the UML diagram's overcomplexity.