search

sarahchow03 / pe

0 stars 0 forks source link

Notation issues in UpdateCommand sequence diagram #11

Open sarahchow03 opened 1 week ago

sarahchow03 commented 1 week ago

Description

image.png

The UpdateCommand sequence diagram has a few notation issues, mostly related to the return arrows in the diagram. In this diagram, there are no return arrows (denoted as dotted arrowhead lines) in the following activation bars.

The throw exception arrow should also be noted with a dotted arrowhead line, and not a solid line. The successful return of the command (back to the caller of execute) is also not indicated in the diagram, thus, it is unclear when and what happens when a successful command is run.

The severity was bumped up from the usual veryLow to Medium due to the frequency of error in this diagram.

This issue is also observed in AddCommand.

{5651157C-171A-4399-B403-7E9784E77ED4}.png

nus-pe-bot commented 1 week ago

Team's Response

Thank you for pointing this out to us! However, our return arrows are omitted because they return void which complies with UML standards. Actually all methods in our sequence diagrams return void and hence have no return arrows. Furthermore the textbook doesn't state that exceptions are a return type and so we don't really need to use a dashed line to represent. You do get the gist of what that arrow for exception means and we feel that that is what matters for brevity and clarity. Hence we will be classifying this as not in scope or at the very least a cosmetic issue.

Items for the Tester to Verify

:question: Issue response

Team chose [response.NotInScope]

Reason for disagreement: [replace this with your explanation]

## :question: Issue severity Team chose [`severity.VeryLow`] Originally [`severity.Low`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]