search

starchypotatocode / pe

0 stars 0 forks source link

Misleading and even incorrect error message: Find #8

Open starchypotatocode opened 1 week ago

starchypotatocode commented 1 week ago

image.png

Reproduce: See Image

Expected: Something that tells me I can input /classes and so on and so forth like the UG.

Actual: See Image - The wording suggests that I can only use this to search by tags, which is completely incorrect.

Similarly,

image.png

implies that I am barking up the wrong tree, when the actual problem is that I did not input a name after /name here.

nus-se-script commented 1 week ago

Team's Response

No details provided by team.

The 'Original' Bug

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

Help message for Find command is ambiguous and unclear

When I input an incorrect usage of the find command, for example, without specifying anything after find, I am greeted with this help message:

image.png

This seems to suggest that find can only be used on tags, as there really exists a tag field.

However, from the user guide, it is apparent that the find command can be used on many other parameters, e.g. name, gender etc. This is plucked from the UG:

image.png

I suggest that the help message for the find command be updated to be clearer and to signal to the user that they can search for attributes other than tag.

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

Their Response to the 'Original' Bug

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

Thank you for the feedback!

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 severity Team chose [`severity.VeryLow`] Originally [`severity.Medium`] - [x] I disagree **Reason for disagreement:** While severity.Low can be argued for, severity.VeryLow is only for cosmetic bugs, and this error message is misleading to users (who may never see the need to check the user guide if the existing message is superficially correct and fits their existing expectations) and thus affects their behaviour and indirectly causes them inconvenience when they have to seek out unnecessary workarounds. Therefore this is not a cosmetic error and the assigned severity is inappropriate. (Elaborating, the extra work that went into the find feature is something that would have been very helpful for the use context of the application, but this wording may render it effectively nonexistent for a significant fraction of users - searching by name or class or subject seems very useful, but that possibility is unknown to any user who just sees the error message. And this is visible in the UG, so it's not a case of unfinished feature that wasn't disabled properly either, it is something that is intended to be used.)