search

zhoyx / pe

0 stars 0 forks source link

Error message Parameters suggestion different from User Guide for edit-doc command #6

Open zhoyx opened 1 year ago

zhoyx commented 1 year ago

There are no "[]" around fields such as NAME and EMAIL but they are present in the user guide, this might make users think that all fields have to be inputted but in actual fact, most are optional for edit-doc command

image.png

image.png

nus-se-bot commented 1 year ago

Team's Response

Valid bug. Downgraded to Very Low as the functionality of the edit-command is not affected and users can still know about the correct use of the edit command through the user guide.

Items for the Tester to Verify

:question: Issue severity

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

Reason for disagreement: VeryLow as per the definition is for cosmetic bugs that do not affect usage of the application at all. In this case there is a discrepancy in the command format between the User guide and the Application prompt. The user would not be able to know which version is the correct one and thus only through trying out the different commands can the user figure out the proper usage of the edit command. This does cause inconvenience to the user and so I feel that it should be at least severity Low.