search

LimJunxue / pe

0 stars 0 forks source link

Unexplained classes in storage class diagram #9

Open LimJunxue opened 3 years ago

LimJunxue commented 3 years ago

image.png

BudgetBabyStorage and BudgetBabyStorageManager are seperate, have no relation to the other classes and have no explanation for being included. This defeats the purpose of including it in the diagram, and even highlights the fact that there are redundant classes in the code.

nus-pe-bot commented 3 years ago

Team's Response

Hello, thank you for spotting this mistake.

They are documented classes. BudgetBabyStorage was meant to replace Storage. Likewise, BudgetBabyStorageManager was meant to replace StorageManager.

Items for the Tester to Verify

:question: Issue severity

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

Reason for disagreement: I believe the severity of this bug should be higher. Given that BudgetBabyStorage and BudgetBabyStorageManager are actually in the code and not Storage and StorageManager, intended readers of the DG (who most likely are future developers) will not be able to use this diagram as the inheritance or structure of the classes are not correctly documented. This hinders their progress, potentially causing confusion and reduces the usefulness of the DG, whose purpose is to guide developers.