search

lkldev / pe

0 stars 0 forks source link

Storage class diagram missing dependency to InsurancePackagesStorage #14

Open lkldev opened 2 years ago

lkldev commented 2 years ago

Bug

Missing dependency to InsurancePackagesStorage. Since dependencies to AddressBookStorage and UserPrefsStorage are illustrated, dependencies to InsurancePackagesStorage should be illustrated as well. Giving High as the dependency on InsurancePackagesStorage is not documented anywhere else, but is visible in the code. New developer would not know that such dependency exist without reading the code.

Screenshots

image.png

image.png

nus-se-script commented 2 years ago

Team's Response

We accept that this is an issue, and we believe that this deserves a Low severity. This is because it is isolated and does not cause any further confusions/misinform the user in any later sections of the DG.

Items for the Tester to Verify

:question: Issue severity

Team chose [severity.Low] Originally [severity.High]

Reason for disagreement: I feel that this would at least be a severity.Medium considering that this dependency InsurancePackagesStorage is important to the product as a whole. Since there is no dependency illustrated, readers may assume that there is no additional dependency required for the StorageManager. Furthermore, there is no mention of InsurancePackagesStorage in the DG at all, which new developers will have to read the code to know the usage of InsurancePackagesStorage.