Jaspertzx / pe

0 stars 0 forks source link

The EditCommand Sequential Diagram is incomplete/missing many key details. #11

Open Jaspertzx opened 2 months ago

Jaspertzx commented 2 months ago

Firstly, in the Sequential Diagram, it fails to show the EditCommand's references to the Person class under the Model Directory.

In EditCommand.java line 126, it calls the constructor method of Person.java, however this contructor method call is missing in the Sequential Diagram shown below. (Model.java does not contain any methods to create the person, but rather the Person object is created in the EditCommand.java and passed to the Model Interface).

Additionally, the public static classEditPersonDescriptor in EditCommand.java line 159 is not mentioned as well. This should be reflected in the Sequential Diagram with the Static Class created for this nested class.

Rationale for a low: As a developer, this is misleading when working on this code base for future implementation. I would assume that the DeveloperGuide contains the minimal information that I need to know on which classes are utilised for the EditCommand operation. However, in this case, the method calls and constructor calls to Person.java is missing. This misrepresentation of logical flow could cost valuable time when building an application, and thus I have given this a low.

image.png

nus-pe-bot commented 2 months ago

Your response not required for this bug as the team has accepted the bug as it is.