nus-pe-bot
commented
1 year ago Team's Response
No details provided by team.
The 'Original' Bug
[The team marked this bug as a duplicate of the following bug]
Documentation for the currency code is poor
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.
There are so many features as illustrated in the UG which leverage on CURRENCY (valid currency codes) as one of the accepted inputs.
However, there is no documentation at all to show what are the available range of valid currency codes a user can enter. Hence, it is difficult to use different currencies since I don't know the valid currency codes on top of my head. My recommendation will be having a list of countries and their respective currency codes, to be displayed in the UG so that the user can see the range of valid currency codes.
As a user, it is very difficult for me to enter any other currency other than SGD and MYR since these are what most of us here in Singapore are aware of.
[original: nus-cs2113-AY2223S1/pe-interim#827] [original labels: type.DocumentationBug severity.Medium]
Their Response to the 'Original' Bug
[This is the team's response to the above 'original' bug]
Hi there,
We would like to clarify that the currency codes is something that can be easily found on google or other search engines. It would not be feasible for us to list hundreds of countries and their respective currencies in our user guide.
Items for the Tester to Verify
:question: Issue duplicate status
Team chose to mark this issue as a duplicate of another issue (as explained in the Team's response above)
- [ ] I disagree
Reason for disagreement: [replace this with your explanation]
:question: Issue response
Team chose [response.Rejected]
- [x] I disagree
Reason for disagreement: At the very least, there should be some mention in the documentation of the exchangeRates.txt file where the currency codes are listed. Even if the idea is for users to look up currency codes on Google, this should be mentioned as an instruction in the UG.
The usage of currency codes is crucial to this program, and thus some mention should be made to how one can find this information (in the txt file mentioned above, or that the intended behaviour is for users to first look up/google currency codes).
In the User or Documentation Guide there is no explanation on what valid currency codes there are, leading the user to guess at what a valid currency code is.
There is a file,
exchangeRates.txt, that could be used as a reference, but no reference is made to this file either.As currency conversion is the backbone of the program, having a list of valid currency codes that a user could refer to will make the program much easier to use.