SongZijin / pe

0 stars 0 forks source link

Inconsistancy in sequence diagrams of commands #4

Open SongZijin opened 1 year ago

SongZijin commented 1 year ago

In the first sequence diagram (for runBagPacker() Mechanism), the command object is shown to be deleted after it is done executing, as shown below: Screenshot 2023-04-14 at 5.26.55 PM.png However, this is not the case for sequence diagrams of the specific diagrams that are found in later parts of the developer guide. Screenshot 2023-04-14 at 5.28.01 PM.png

nus-pe-bot commented 1 year ago

Team's Response

The red cross representing the deletion in :PackCommand (in the second image) is missing, there is no grounds for this being a medium level severity and should be very low as it is a typo which does not affect the readers understanding of the diagrams.

Items for the Tester to Verify

:question: Issue severity

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

Reason for disagreement: I agree with the fact that it should not be Medium, however, I think this should have a severity of Low, since VeryLow is only for cosmetic components like formatting, while the inconsistency in the diagrams may confuse the reader in understanding if the command object is deleted or not and how the first diagram relates to the others.