search

nus-cs2103-AY2324S2 / pe-dev-response

0 stars 0 forks source link

Naming error in Model UML diagram #3127

Open nus-pe-bot opened 2 months ago

nus-pe-bot commented 2 months ago

Note from the teaching team: This bug was reported during the Part II (Evaluating Documents) stage of the PE. You may reject this bug if it is not related to the quality of documentation.

image.png

image.png

The UML uses "UniqueEmployeeList" but the github gist at https://github.com/AY2324S2-CS2103T-T15-4/tp/blob/v1.4/src/main/java/seedu/address/model/ModelManager.java actually uses "filteredEmployees".

This might make it difficult for a new contributor to navigate the Model.

[original: nus-cs2103-AY2324S2/pe-interim#2552] [original labels: severity.Low type.DocumentationBug]

BryanL2303 commented 2 months ago

Team's Response

The tester seems to be claiming that ModelManager in the code uses filteredEmployees, which would be correct as per the screenshot of the code, while the UML diagram shows that it is using UniqueEmployeeList.

However, the UniqueEmployeeList is connected to TaskMasterPro instead of to ModelManager. TaskMasterPro is the class that consists of the UniqueEmployeeList instead.

The ModelManager in the UML diagram is instead connected directly to Employee and it is indicated that it is filtered.

Duplicate status (if any):

--