search

germainelee02 / pe

0 stars 0 forks source link

Wrong UML sequence diagram #25

Open germainelee02 opened 1 year ago

germainelee02 commented 1 year ago

Your UML sequence diagram for sort is wrong. In SortCommand, it also calls model.commitSocket after model.sortPersonList which is not reflected here

Screenshot 2023-04-14 at 3.28.27 PM.png

soc-pe-bot commented 1 year ago

Team's Response

This DocumentationBug is reclassified at a Low severity, and is rejected. This sequence diagram is mainly concerned with how the SortCommand works, while model.commitSocket is more relevant to the undo and redo features. As such, model.commitSocket is intentionally omitted, as it is not significantly relevant to the user in understanding how the execution of the command is handled.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: [replace this with your explanation]

## :question: Issue severity Team chose [`severity.Low`] Originally [`severity.Medium`] - [x] I disagree **Reason for disagreement:** I disagree. At that abstraction level, you showed `showPersonList` in the UML diagram. `commitSocket` is at the same abstraction level as your `showPersonList` (which you chose to include). Can you just choose to include and exclude methods as you see fit? Since they are at the same abstraction level, I believe `commitSocket` should also be included in the UML diagram, not only for consistency, but so as to not confuse the reader. A reader might look at the UML diagram and think that `commitSocket` is not called at all. That is erroneous.