Dominic-Khoo / pe

0 stars 0 forks source link

Find command returns incorrect result #5

Open Dominic-Khoo opened 2 weeks ago

Dominic-Khoo commented 2 weeks ago

When the command "find ui" is entered, one of the companies listed (i.e Microsoft) has no "ui" within tags, applications or name but it still appeared. The screen recording attached shows this scenario more clearly!


video:https://raw.githubusercontent.com/Dominic-Khoo/pe/main/files/0ffbf822-3085-489e-b14a-f11c63d04e13.mov

nus-se-script commented 1 week ago

Team's Response

Good catch! However, this issue will be marked as low, and as a documentation bug.

While it may seem like an incorrect result was output, we did not specify in the User Guide that as long as any part of the company name, tags, application names and application details matches the keyword, the company will be displayed in the output. As a result, the results shown were due to the phrase "ui" being a part of the application details, which are hidden in the current list view. We will classify this as a documentation bug since this behaviour was not clearly documented in our User Guide.

This issue is also marked with a low severity as it will unlikely affect normal operations of InternBuddy, this confusion will be for users who have just started using InternBuddy, with a better understanding of the scope of the find command, this behaviour will not be viewed as faulty.

Items for the Tester to Verify

:question: Issue type

Team chose [type.DocumentationBug] Originally [type.FunctionalityBug]

Reason for disagreement: Actually, after the PE, I did realise that the find command searching for application details was probably the reason behind this behaviour, but I was unable to change or edit my comments after the window closed. While I do agree that this could definitely be classified as a DocumentationBug by including further details in the UG, would it be more appropriate to consider this issue as a FeatureFlaw instead?

Because, personally, if application details are not going to appear in the PersonCard and the user types find "UI", let's just picture a scenario where there are hundreds of application details with the keyword that you are searching for (but the full entries are not necessarily the same), you would have to individually search through the results to find the particular company/application that you are looking for.


## :question: Issue severity Team chose [`severity.Low`] Originally [`severity.Medium`] - [ ] I disagree **Reason for disagreement:** [replace this with your explanation]