search

fxe025 / pe

0 stars 0 forks source link

Storage wipeFileClean() elaboration #11

Open fxe025 opened 2 months ago

fxe025 commented 2 months ago

It is an important method as errors loading the file will trigger this method to clear everything in the file. Better to explain it in DG.

soc-se-bot commented 2 months ago

Team's Response

The name itself is self-explanatory and the implementation is trivial compared to other contents of the DG this method is deprioritised and we do not see the need to add.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: While the method name itself is straight-forward enough, in your DG, this method is only shown in the Storage class diagram, which itself didn't manage to show the triggering condition of this method, and how it interacts with user's file. If diagrams are not suitable, a good alternative could be to explain this method in a few words under Storage section, which I also didn't see. Without an explanation could leave the readers unsure of where to implement this method. I myself only knew that this method was a mechanic to deal with incorrect file text format when I actually edited my file and had my data erased during the program test run.