nus-cs2103-AY2425S1 / pe-dev-response

0 stars 0 forks source link

`clear-event` command does not suggest it clears all events. #416

Open nus-pe-bot opened 1 week ago

nus-pe-bot commented 1 week ago

Potentially misleading command name as users may initially think that it expects a parameter. Not a functionality flaw, as this is documented within the UG under features.

clear-event 1 would result in all events being deleted. This would not be the desirable outcome for users and perhaps restricting any inputs with this command should result in an invalid command structure and raise an error message instead.

Input: Screenshot 2024-11-15 at 5.04.14 PM.png

Result: Screenshot 2024-11-15 at 5.04.28 PM.png

Regardless, would only affect users who skim and do not read the UG properly.


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

chuajunyu commented 1 week ago

Team's Response

Thank you for the bug report. While we agree that there is space for improvement here, we are setting this as NotInScope.

We agree that this could be better, however, since the naming convention of this command and it's exact behaviour has already been clearly noted in the User Guide, we expect that users will be aware of what the command actually does and it should be fully understandable to users what this command does.

image.png

However, we agree that this could indicate an issue with the naming of the command. However, it was not a main priority in the latest iteration since there are no bugs with this command at all. As such, we are setting it to be NotInScope.

Duplicate status (if any):

--