search

sagarsureka / pe

0 stars 0 forks source link

Functionality issue in create command #8

Open sagarsureka opened 3 years ago

sagarsureka commented 3 years ago

The ug specification and the actual execution for the create command do not match.

The ug has the following format

Screenshot 2020-11-13 at 2.33.43 PM.png

When trying to create a template with command create n/burpee d/up and down c/1000 it returns an error which says there is a problem in the name field which is misleading Screenshot 2020-11-13 at 2.32.39 PM.png

When trying to create a template with command `create n/burpee c/1000 m/fullbody it successfully creates the template but the format is contradictory to the ug

Screenshot 2020-11-13 at 2.33.04 PM.png

nus-pe-bot commented 3 years ago

Team's Response

No response provided.

Items for the Tester to Verify

:question: Issue type

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

Reason for disagreement: A functionality bug is when a functionality does not work as expected. A documentation bug is one where there is some issue purely in the documentation. In this case, due to a incorrect format in the user guide the functionality is not working as expected. Hence, I feel this is a functionality bug. Furthermore, this bug also consists of the aspect of misleading error messages when the command is incorrect.

:question: Issue severity

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

Reason for disagreement: The team does not provide any reason for downgrading the severity. I felt that this bug deserved high severity because it makes the feature of having exercise templates practically not usable. Users may not be able to understand how to actually use the feature by their intuition, especially because both the UG and the error message lack the reference to the correct format.