nus-cs2113-AY2324S2 / pe-dev-response

0 stars 0 forks source link

Class diagram too complex for Storage class #787

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.


It is mentioned that the storage class only deals with logList and userDetailsList. However, the class diagram includes several additional classes, making it confusing for developers. Instead, the class diagram should only contain storage, userDetails and logList classes. This could be severity.low as it can cause issues for the developer in understanding the storage class which is key to the functioning of the application.

image.png


[original: nus-cs2113-AY2324S2/pe-interim#919] [original labels: type.DocumentationBug severity.VeryLow]

nikhil-2101 commented 2 months ago

Team's Response

No details provided by team.

Duplicate status (if any):

--