search

laurenlhy / pe

0 stars 0 forks source link

Confusing error message when finding customer #1

Open laurenlhy opened 3 years ago

laurenlhy commented 3 years ago

Following the example given in user guide quick start,

image.png

I tried finding Bob Ang with his preferred car:

image.png

image.png

I find the error message confusing and I do not know why this command is failing to work.

If only one parameter is acceptable for 'find' command, then the example given in User Guide quick start is wrong.

nus-pe-bot commented 3 years ago

Team's Response

this error message was to basically oppose : find a/something /and a/2thing a/3thing /and p/123. Parts where no operator is given or such are many more cases, and writing different error messages for each such case is difficult, hence this is part of a future update.

Items for the Tester to Verify

:question: Issue response

Team chose [response.NotInScope]

Reason for disagreement: Quick Start is a section which a new user (with little familiarity of the app) is likely to read, so having an invalid example in this section will cause minor inconvenience to users as they will be confused as to what went wrong. The error message from the app does not help much with the confusion. At least, the examples in Quick Start should be updated so that they are valid commands. This is a valid Documentation Bug with Low severity.