Minimal description for "Storage" class in DG

[nus-se-script]

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.

---

The above screenshot is the only description about the Storage Class in the DG. More developer descriptions should be added in order for better understanding of how this class works.

Suggestions:

1. Add in Class diagram and sequence diagram.
2. Add in the path of the txt file that stores the data
3. Add in the format of how the tasks are stored into the txt file.

---

_{[original: nus-cs2113-AY2324S2/pe-interim#1336] [original labels: severity.Medium type.DocumentationBug]}

[itsmejr257]

Team's Response

Thank you for the suggestion. We understand that it is a valid issue. However, regarding the Storage Class, we believed that the code comments explaining each method was sufficient in explaining what each of the methods do in the storage class and ,hence, only included when these methods are invoked as we believe this was the only unclear issue about the Storage Class.

Moreover, our main focus on the Developer Guide was to focus on the main features of BudgetBuddy, etc (adding, editing ,loading of expenses/savings) which is why our implementation sections were significantly longer, and with more diagrams as compared to this section here.

Therefore, we agree with the Medium Severity as the lack of extra information may cause inconvenience to developers who do not have access to the code, however, we have classified this as NotInScope as this was not of a higher priority than the explanations of the implementations in the DG.

Duplicate status (if any):

--