carriezhengjr / pe

0 stars 0 forks source link

Missing method call label for sequence diagram for Edit Internship in DG #12

Open carriezhengjr opened 1 year ago

carriezhengjr commented 1 year ago

There's a method that creates a CommandResult, but the method label is not in the sequence diagram. This is highlighted in the screenshot below using the red rectangle box: Screenshot 2022-11-11 at 17.27.42.png

soc-se-bot commented 1 year ago

Team's Response

The omission of the method call for the creation of Command Result does not result in the loss of relevant information.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: The module website mentioned that optional elements such as activation bars and return arrows may be omitted, which did not include the operation invoked. As seen from the sample diagram provided on the module website, the operations invoked (method calls) are all labelled clearly. Screenshot 2022-11-15 at 15.32.31.png

Furthermore, with respect to the team's sequence diagram, the reader is unclear about what operation has caused the final return of result since the operation invoked here that leads to the creation of CommandResult was not labelled. Hence, relevant information is missing.

Arrows representing method calls should be labelled clearly with the name of the operation to avoid ambiguity and confusion that the reader may face. In addition, there should be more consistency in the sequence diagram, i.e. if the method call for the creation of EditInternshipCommand has been clearly labelled, the method calls for the creations of CommandResult and EditInternshipCommandParser should also be labelled as a good practice.