gavin331 / pe

0 stars 0 forks source link

Misinformation in the UG #10

Open gavin331 opened 5 months ago

gavin331 commented 5 months ago

image.png

image.png

Not all the data is deleted when the data file is manually edited. Here, I edited the category of the 1st person to be 'Name' which should not be allowed since it already exists. However, only the data for the 1st person is deleted.

nus-pe-script commented 5 months ago

Team's Response

Works exactly as seen. Certain edits to the addressbook will cause our app to work in unexpected ways. In this case, it was editted incorrectly by adding in a duplicate category when duplicate categories are explicitly not allowed in our app, causing it to work in an unexpected way, in this case deleting all entries of that person. Looks like a user error rather than a bug, who ignored the warning message to not edit the json file unless confident to be correct.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: The team agreed that duplicate categories are explicitly not allowed in their app, so in my opinion, it can be considered as an invalid format. In the user guide, it is stated that if the format is invalid, then Addressbook will discard all the data and start with an empty data file in the next run which did not happen as shown in the screenshot (there are still data in the file).

But the user guide also states that certain edits can cause it to work in an expected way which is true. So, the main point is that the first sentence wasn't true in this case although the 2nd sentence makes up for it. Hence, it will be better to just remove the 1st sentence about how addressbook will discard all the data and start with an empty data file in the next run. This will help to solve the ambiguity among the 2 sentences and reduce the reader's confusion.