nus-cs2103-AY2122S1 / pe-dev-response

0 stars 0 forks source link

Missing warning for editing of json file may lead to wiping of data #4714

Open nus-pe-bot opened 2 years ago

nus-pe-bot commented 2 years 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.


Steps to reproduce:

  1. Add an ingredient that is expiring (add ingredient -n Grapes -q 4 -d Black seedless grapes -e 20-08-2021 -t fruit -t sweet)
  2. Close the app
  3. Go to the json data file and delete the 'expiring' tag from said ingredient
  4. Open the app again

File is also wiped for duplicate ingredients.

Editing a json file to an invalid data will automatically wipe the file and start a new one. There should be a warning in the UG about this, especially since the reader/user will lose all their data and not just the invalid ingredient.

Suggestion: Add a warning under a section called editing json file that the file will be wiped if XXX conditions are met (e.g. invalid data like duplicates or expiring tag missing)


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

NayLin-H99 commented 2 years ago

Team's Response

Ok.

Duplicate status (if any):

--