nus-cs2103-AY2425S1 / pe-dev-response

0 stars 0 forks source link

Not enough example for how to use exclude functionality #1223

Open nus-pe-bot opened 2 weeks ago

nus-pe-bot commented 2 weeks ago

There are no examples for users to know how to use exclude with multiple contacts. This might lead to users getting frustrated if this is their first time using the application.

image.png

image.png

This made me unable to exclude multiple contacts as there were no examples that a comma was needed.


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

jan-kai1 commented 2 weeks ago

Team's Response

The team disagrees with the high severity of the issue suggested by the tester. While a direct example on how to exclude multiple contacts is not shown, this does not cause major problems for most users and more importantly does not make the product unusable for most users.

As shown in the screenshot posted by the tester, the format clearly indicates how to specify multiple contacts to be excluded at once.

image.png _Format indicates that exclude ci/INDEX, [MORE_INDICES] is used to exclude multiple contacts_

Moreover, the in-app error message also displays an example of how to exclude multiple contacts at once, which a user can find by inputting exclude

image.png exclude ci/1,5 shows a user how to exclude multiple contacts at once

While there is a lack of direct examples shown in the User Guide, the information is readily available elsewhere in both the command format and in-app error message.

We admit that this may cause inconvenience in the cases where a user both:

However, we feel that this is a rare situation that will only cause minor inconvenience for the user, and the normal operations of the exclude command on single contacts remain unaffected.

As such we propose a low severity instead.

Duplicate status (if any):

--