nus-cs2103-AY2425S1 / pe-dev-response

0 stars 0 forks source link

Incorrect and inconsistant command instruction for find result #1688

Open nus-pe-bot opened 1 week ago

nus-pe-bot commented 1 week ago

The command instruction in the UG is: image.png

image.png

In which, the error message for the find command in the app shows: image.png

I believe the command instruction given by the error message in the app is the correct instruction.

User might never realise that the find command actually works with find [a/KEYWORD_FOR_ADDRESS 1 KEYWORD_FOR_ADDRESS_2] and hence interpret the result from find command wrongly.

And also the user might not be able to realise the useful use case for find command to have a quick search on the schedule like: find ld/tue thu

Even thought the UG did try to make it clear with:

image.png

It still might not be clear to the user with the exact behaviour of find command. Especially with the useful feature of find ld/Tue thurs


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

luileng commented 1 week ago

Team's Response

I believe that this is considered a typo.

In the UG, we have made the command format clear with:

Furthermore, the command instruction in the UG is NAME_KEYWORDS etc, which is plural (instead of NAME_KEYWORD) hence users likely know that they are able to input multiple keywords.

Though I agree that it would be better if the UG was consistent with the error message. As such, I have accepted this but adjusted the severity level to very low.

Duplicate status (if any):

--