search

SeeuSim / pe

0 stars 0 forks source link

Unclear Sequence Diagram #22

Open SeeuSim opened 1 year ago

SeeuSim commented 1 year ago

It is unclear how the user interacts with the UI, and simply a string "p delete -i 1" is shown

It could be "enters command into commandBox" instead for clarity

Screenshot 2023-04-14 at 3.12.21 PM.png

nus-pe-bot commented 1 year ago

Team's Response

Other parts of our documentation have already covered how a user interacts with the UI.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: Regardless, this is a Sequence Diagram.

Within Sequence diagrams, the labelling on the arrow should indicate the operation invoked on the object.

While the nature of the interaction may be documented in the guide, this mere "string" gives no clue as to the concrete interaction between the User object and the UI class, for the purposes of the Sequence Diagram within UML conventions.

Thus, this is a minor error with the Sequence Diagram that warrants at least a Very Low severity.