search

ziyi105 / pe

0 stars 0 forks source link

Mismatched behaviour for storage saving #21

Open ziyi105 opened 8 months ago

ziyi105 commented 8 months ago

image.png

The meal data file was not updated as I add new meal

nus-se-script commented 8 months ago

Team's Response

Thanks for highlighting this. This is a typo as option 2 is suppose to be the currently implemented method.

Items for the Tester to Verify

:question: Issue severity

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

Reason for disagreement: Although this is a typo, it changes the meaning of the sentence completely and can mislead the reader. Moreover, this is not merely a typo which can be spotted by the reader easily, it significantly affects how reader understands the storage component and the reader might never find out that his understanding of the whole storage system is wrong if he doesnt read the code. Hence, I believe the severity is at least medium.

DG is the first thing a developer new to an app will read before going through the actual code. Hence, if the developer understands from the DG that option 1 is currently implemented, he would expect the code behaves like option 1. If there is a mismatch between the implementation and the option chosen in DG, it would confuse the developer (imagine your tutorial answer is different from the model answer given by your prof, you would probably doubt your own answer first and double check it a few times before you start suspecting the correctness of model answer).