DreamerDragon / pe

0 stars 0 forks source link

Wrong instruction given in the UG #7

Open DreamerDragon opened 4 years ago

DreamerDragon commented 4 years ago

Under adding a calorie input, when i followed UG and entered the example given: calorie d/2020-10-26 tp/in t/1200 e/running c/400, the console shows an error telling me this is wrong format. Which confuses me of how to use this. Screenshot 2020-11-13 at 5.07.13 PM.png Screenshot 2020-11-13 at 5.07.24 PM.png

nus-se-bot commented 4 years ago

Team's Response

Slight typo error, the rest of the command is still valid.

Items for the Tester to Verify

:question: Issue type

Team chose [type.DocumentationBug] Originally [type.FunctionalityBug]

Reason for disagreement: This can be argued as a documentation bug, however, when the wrong example is entered, it is indeed that the system is not performing as what the user guide instruction is expecting hence can be a functional bug. This typo should be both a doucmentation and a functionality bug.


:question: Issue severity

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

Reason for disagreement: Example is part of the instruction and the conflicting or wrong instruction ( example) given will cause users to be confused and cause some problems. This error should be avoided and not simply be ignored as the example plays a crucial role for illustrating the instructions and giving users a sample to try out. The issue should have a severity of medium.