malcolmang / pe

0 stars 0 forks source link

No documentation on editing or the use of the `exchangeRates.txt` file #10

Open malcolmang opened 2 years ago

malcolmang commented 2 years ago

There isn't any documentation in the User Guide on what support behaviours are for this file. The file appears to not be editable as it is only read from inside the .jar (or an API, it's not stated).

The constraint "Human Editable File" (https://nus-cs2113-ay2223s1.github.io/website/admin/tp-constraints.html#constraint-human-editable-file) implies that the txt file should be editable, or at least an explanation should be given to the user for if editing the file is unsupported.

soc-se-bot commented 2 years ago

Team's Response

Hi there,

Human editable file asserts that you are able to edit the file even outside of the jar file. In the case of exchangeRates.txt, you can easily use a text editor to edit the contents of the file outside of the program.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: I concede that the file is technically "editable", but fails the second portion: "Reason: To allow advanced users to manipulate the data by editing the data file." However, what is in question here is not the editability of the files but the documentation's lack of information on editing behaviour.

The documentation should provide information on what editing the file can/cannot do: in this case, it appears to do nothing (is read-only). This information would be valuable for users to know that they can't change the rates from the .txt file.

I still hold that a section on supported/unsupported behaviour for file editing can be useful to users, since some might try to access files and edit them (as per the "Human Editable File" constraint).

I would suggest in this case to mention that this text file is read-only and editing the file will not make any changes to the program or its rates at all.