shaunlxw / pe

0 stars 0 forks source link

Invalid prefixes does not output accurate error message #2

Open shaunlxw opened 4 months ago

shaunlxw commented 4 months ago

Input: add n/john m/A1234567X e/s@ss tl/thejohn tag/friend

image.png

nus-pe-script commented 4 months ago

Team's Response

Severity Low since it only occurs in very rare situations when a user uses the incorrect prefix for tag. By following the format stated in the UG, a user would not encounter this issue.

Items for the Tester to Verify

:question: Issue severity

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

Reason for disagreement: The above situation can happen in two different context:

  1. The user is unaware of the correct prefix for tag (or any other field)
  2. The user has a typo in prefixes.

E.g.:

  1. add n/John m/A1234567X e/john@example.com tl/thejohn y/friend instead of t/friend (note that y is right beside t, in this case typo)

image.png

  1. add n/John m/A1234567X tele/thejohn e/john@example.com tl/thejohn t/friend

image.png

The combined effect of these two situations can happen quite frequently. Apart from that, the main problem is that the error message brings attention to the wrong place. In the examples above, the attention is brought to the telegram handle in the first example, and the matric number in the second example, although the issue is elsewhere. Because of this, the user would spend a disproportionate amount of time figuring out what is wrong with their command, which brings major inconvenience.