ChocoRagdoll / pe

0 stars 0 forks source link

Lifeline of the command parsers #12

Open ChocoRagdoll opened 3 months ago

ChocoRagdoll commented 3 months ago

image.png

In the sequence diagrams of the commands, the command parser (in the above case, the EditCommandParser) has a lifeline that extends beyond the cross, which is supposed to signify the end of the object's lifeline.

This is due to the limitation of the puml diagrams, but the absence of an explanation may make the diagram confusing for the fellow engineers working on this project.

Since this issue is present for all the command sequence diagrams, I will tag this as medium.

nus-pe-script commented 3 months ago

Team's Response

Thank you for the feedback. We should have included the note for this diagram. However, this issue is not present for all command sequence diagrams, only the editCommand and viewCommand sequence diagrams. For example, this is explained in other diagrams.

CleanShot 2024-04-22 at 00.13.38@2x.png

Therefore, we believe that most developers reading the developer guide would be familiar with this notation and understand it. As such, we believe that this should be classified as severity.low instead.

Items for the Tester to Verify

:question: Issue severity

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

Reason for disagreement: [replace this with your explanation]