mesyeux / pe

0 stars 0 forks source link

Invalid prefix not specified #5

Open mesyeux opened 3 years ago

mesyeux commented 3 years ago

Error message specifies "invalid prefix near -a -pp", which doesn't make a lot of sense - what is "near"? The specific prefix is not specified. Screenshot 2021-04-16 144058.png

nus-pe-bot commented 3 years ago

Team's Response

Relabeled to VeryLow and NotInScope as issue is only textual and can be open for further discussion. Issue has little to no impact to usage. Proper prefixes are stated in the error message.

The definition of "near" is "at or to a short distance away; nearby"

Therefore "Invalid prefix near '-a -pp'" would mean an invalid prefix within the given string or around the given string.

Due to the complexity of the argument parser, the "near" implementation is chosen as it provides a relatively simple way of informing the user that he/she has provided an invalid input.

Exmaple:

Executing filter -n -a -invalid -p -p asdf will return you Invalid prefix near '-p -p asdf' where you can see that there is an invalid prefix provided -p asdf

After fixing the issue and executing filter -n -a -invalid -p, the error message will show Invalid prefix near '-a -invalid -p' where you can see there is an invalid prefix provided -invalid.

If the error message is simply "Invalid prefix at -p", it would be too vague for the user to know what is the exact error. Example, if a user supplies filter -p -p -p -p -asdfasdf -p -p, the error message of "Invalid prefix near '-p -p -p -p -asdfasdf -p -p'" gives the user sufficient contextual knowledge on how to resolve this issue.

Items for the Tester to Verify

:question: Issue response

Team chose [response.NotInScope]

Reason for disagreement: [replace this with your explanation]


:question: Issue severity

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

Reason for disagreement: [replace this with your explanation]