nus-cs2103-AY2223S1 / pe-dev-response

0 stars 0 forks source link

Confusing clear command description in User guide #4731

Open nus-pe-bot opened 1 year ago

nus-pe-bot commented 1 year ago

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.


Clear command description: "Clears all stored data (excluding gym locations) on all days from NutriGoals. " As a user, I did not expect gym locations to be cleared. Specifying that gym locations are not cleared suggests to me that other app data not input by me are cleared, such as the default calories for find, e.g find rice will not longer show me "Calorie content of rice: 260 calories". It seems unnecessary to specify that gym locations are cleared as users cannot store gym data to begin with (it comes with the app)


[original: nus-cs2103-AY2223S1/pe-interim#4619] [original labels: severity.VeryLow type.DocumentationBug]

xav168 commented 1 year ago

Team's Response

The json file stores our gym locations, hence it could have had the potential to be cleared. On the other hand, the default calories are not stored in the json file at all, hence they do not have the potential to be cleared. Furthermore, we did this as we have plans to allow users to input other gym locations in the future and was future proofing our description.

Duplicate status (if any):

--