rynlwhh / pe

0 stars 0 forks source link

Find command UI error message misleading #9

Open rynlwhh opened 1 week ago

rynlwhh commented 1 week ago

In the UG it states that find command finds clients by name , the UI also says the same thing. But when i simply input command Find Aljunied, it gives me roy balakrishnan which does not have aljunied in his name but in his address, this does not corroborate with the UI error message OR the UG, so this might be misleading to users.

Suggestions: Update UG accordingly or update the find command for strictly names only

Screenshot 2024-11-15 at 5.12.17 PM.png

Screenshot 2024-11-15 at 5.12.28 PM.png

Screenshot 2024-11-15 at 5.11.54 PM.png

Screenshot 2024-11-15 at 5.13.41 PM.png

nus-pe-bot commented 3 days ago

Team's Response

Thank you for your bug report. This misconception was due to a typo in the UG when we elaborated on the “Find” command (See issue #3888 if possible). We acknowledge that there is a typo in the one-liner description at the top of the find command help guide that states “name” instead of “attributes”. However, we have explicitly stated in point 3 that “A client’s name, phone number, address, email and tag can be searched.” Moreover, we have examples that also demonstrate the find command being used to search addresses. The user’s ability to find by name is not affected at all, hence we think the downgrade of severity to VeryLow is justifiable.

The 'Original' Bug

[The team marked this bug as a duplicate of the following bug]

Find s/ takes in address

image.png

I am confused why do s/ find keywords within address. An example of it being used to find address showed up in the user guide but user guides say that s/KEYWORD is used for contacts with very similar names.

So shouldn't find only match users based on keywords found in the name? If keywords can be matched in the address, it not just be used as an example but should also be written in the user guide explicitly.


[original: nus-cs2103-AY2425S1/pe-interim#3713] [original labels: severity.Low type.DocumentationBug]

Their Response to the 'Original' Bug

[This is the team's response to the above 'original' bug]

Thank you for your bug report. We acknowledge that there is a typo in the one-liner description at the top of the find command help guide that states “name” instead of “attributes”.

However, we have explicitly stated in point 3 that “A client’s name, phone number, address, email and tag can be searched”. Moreover, we have examples that also demonstrate the find command being used to search addresses.

The user’s ability to find by name is not affected at all, hence we think the downgrade of severity to VeryLow is justifiable.

Items for the Tester to Verify

:question: Issue duplicate status

Team chose to mark this issue as a duplicate of another issue (as explained in the Team's response above)

Reason for disagreement: [replace this with your explanation]


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