search

Caiyi34777 / pe

0 stars 0 forks source link

Inconsistent error message #19

Open Caiyi34777 opened 3 years ago

Caiyi34777 commented 3 years ago

Some show example correct usage, some don't.

Screenshot 2020-11-13 at 1.10.35 PM.png Screenshot 2020-11-13 at 1.10.27 PM.png

nus-se-bot commented 3 years ago

Team's Response

Examples are given in the UG Examples in the error message are a good to have, and it is not a requirement to always have them. And neither is it a requirement to be consistent Lowering the severity because it does not affect the usage of the app (can use the UG)

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: If you choose to give examples only in the UG for users' reference, the existing example usage in the error message are not as necessary. Currently, your implementation has some example usage only in the UG and has some example usage in both UG and your actual product. Though it is compulsory to be consistent, it is always nicer to have some consistency since a team project should look like it is written by a single person as CS2103/T told so.

:question: Issue severity

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

Reason for disagreement: Currently, your implementation has some example usage only in the UG and has some example usage in both UG and your actual product. The user may have to jump between the UG and your product to refer to the correct usage format of a command and it causes inconvenience. This situation could be avoided if all example usages are provided in the error message itself or state clearly that the user should refer to the UG all the time.