NiniJiaying / pe

0 stars 0 forks source link

[DG] Sequence Diagram for execute("deleteP 1") API call #8

Open NiniJiaying opened 3 years ago

NiniJiaying commented 3 years ago

The message "DeleteProjectCommandParser()" is missing for the action of constructing a DeleteProjectCommandParser object

image.png

nus-pe-bot commented 3 years ago

Team's Response

Thank you for your feedback. For sequence diagrams, the calls to constructors can be omitted for clarity if it does not add much value to the diagram. In this case, labelling all calls to constructors would clutter the diagram unnecessarily. For example, in the week 6 tutorial some operations were omitted to avoid cluttering up the diagram, in particular the constructor of the Parser object.

Screenshot 2021-04-18 at 2.41.20 AM.png

In addition, we do not believe this should be classed as medium severity as it does not hinder the users understanding of mechanism being explained.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: It is quite inconsistent with how a CommandResult is created shown in this diagram. The call for the constructor for CommandResult is present while the calls for the constructor for DeleteProjectCommandParser and DeleteProjectCommand are absent. Consistency is also important in one diagram.


:question: Issue severity

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

Reason for disagreement: [replace this with your explanation]