xxzz-tt / pe

0 stars 0 forks source link

Clear command documentation can be clearer #8

Open xxzz-tt opened 3 years ago

xxzz-tt commented 3 years ago

It would be good to specify that entries in both exercise and template panels would be cleared using the clear command.

Screenshot 2020-11-13 at 5.10.03 PM.png

nus-se-bot commented 3 years ago

Team's Response

Request to downgrade to Very Low since we thought that by entry includes everything that users enter, not just exercise and template. There are other items such as Goals etc. But I agree that explicitly stating them will be better.

Items for the Tester to Verify

:question: Issue severity

Team chose [severity.VeryLow] Originally [severity.Low]

Reason for disagreement: The success command says "Exercise book has been cleared", which I initially thought to mean only the exercises entered will be cleared. Hence, I disagree with the downgrade as it is more than just a comestic bug. The confusion caused by the vague term can result in the users accidentally deleting items that they did not mean to delete. Furthermore, I did not realise that the goals entered will also be deleted upon using this command until the team mentioned it in their response. Thus, I think that it is important to specify the entries that will be deleted in this command so users will not lose their data unnecessarily.