search

ChickenChiang / pe

0 stars 0 forks source link

DG: Description under diagram is unrelated to diagram #14

Open ChickenChiang opened 1 year ago

ChickenChiang commented 1 year ago

In the DG, the description directly under the model class diagram talks about ObservableList<Person>, yet it is not on the diagram.

Either the description needs to be accompanied with another diagram and placed in another section or the description should be removed entirely.

image.png

nus-pe-script commented 1 year ago

Team's Response

The DG is not meant to exist in a vacuum. The code is on github for reference. Furthermore, it is not a bug for the DG to go into specific implementations, and in this case bringing up the specific type of list used is meaningful to potential programmers. It also does not make sense for the class diagram to contain low level implementation details, as this goes against what was taught about UML.

The text description exists to provide more details for the reader, including some important aspects of lower level implementation that is not (and indeed should not) be in the class diagram. This bug is rejected as we do not feel it is a valid criticism on the clarity of the DG, as was insinuated.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: [replace this with your explanation]