bkjwjason / pe

0 stars 0 forks source link

Prefix Error could be better #3

Open bkjwjason opened 1 year ago

bkjwjason commented 1 year ago

When adding an organization/recruiter, a misspell in a required prefix gives the error message: irrelevant options found in the command.

Steps to reproduce:

  1. Add a organization with a wrong spelling for prefix add --ogr --name JohnInc

Screenshot 2023-11-17 at 5.06.07 PM.png

While error message is present, this is not a irrelevant field. Rather, it is a necessary field that is spelt wrongly, and user might have this problem if they type too fast. Error message can be better detailed.

According to course principles, it is a feature flaw, and since users might be able to spot their mistakes quickly, it is severity.low

Screenshot 2023-11-17 at 5.09.13 PM.png

soc-se-bot commented 1 year ago

Team's Response

We understand the concern. Though, a misspelling like --ogr is non-trivial to detect, and requires polynomial time to correctly evaluate (e.g., via Levenshtein distance). Additionally, it would require careful trial and error in determining how low of an error score is required before something is considered a similar match. Hence, we consider this to be out of scope, since it is not worth the effort required to implement this by v1.4.

We also believe that Jobby's autocomplete mitigates the likelihood of typos with fuzzy subsequence matching. A user looking to avoid typos would simply invoke autocomplete to use a full parameter name. For example, a "misspelling" or partial spelling of --o or -og would have suggested --org thanks to autocomplete's loose matches, which is simple for Jobby to detect in linear time. The lack of suggestions would suggest that the user entered an unrecoverable mistake that cannot be detected easily. Thus, we would also consider this to be closer to a deliberate user action to intentionally ignore autocomplete and type an incorrect input.

Items for the Tester to Verify

:question: Issue response

Team chose [response.NotInScope]

Reason for disagreement: [replace this with your explanation]