UG: Deleting a patron do not document what happens to the data saved in the json file.

[nus-pe-bot]

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.

---

Expected:

Documentation of whether will only data be removed from the GUI display or completely from the json file as well.

Actual:

No documentation on behaviour of the json file.

---

_{[original: nus-cs2103-AY2122S2/pe-interim#3508] [original labels: severity.Low type.DocumentationBug]}

[bingsen0806]

Team's Response

According to the module website, UG should not contain every nitty-gritty detail, and should not include information that is either rarely needed, or information that the user is expected to know already.

It is common sense that deleting a patron will remove it permanently, aside from removing it from the GUI, otherwise the command should be named along the lines of “clear from screen” and not “delete”. Mentioning how commands change the json file is considered to be an implementation detail (e.g. delete removes a json object, add adds a json object), which is commonly omitted in User Guides. For example, as a laptop user, you hardly need to know that when you delete a file, how the laptop searches for the block in your harddisk storage and removing that block, and you hardly need to know that the page tables and memory buffers and cache will be updated to remove reference to the block.

Duplicate status (if any):

--