search

avrilmohh / pe

0 stars 0 forks source link

Inconsistencies in error message for sort and sorti commands #9

Open avrilmohh opened 4 days ago

avrilmohh commented 4 days ago

The error message parameters of sort is [f/FIELD] and [o/ORDER]

image.png

However, the error message parameters of sorti is f/[FIELD] and o/[ORDER]

image.png

This might bring confusion to the user because the user would misunderstand that these different formatting mean different things, when in fact both parameters are compulsory in both commands.

soc-pe-bot commented 1 day ago

Team's Response

We understand that this a minor cosmetic issue that can bring some inconvenience to the user however it does not affect the functionality of our commands. Furthermore, we have stated the format for these 2 commands clearly in the User Guide. Thanks for pointing it out.

Items for the Tester to Verify

:question: Issue type

Team chose [type.FeatureFlaw] Originally [type.FunctionalityBug]

Reason for disagreement: This is not a FeatureFlaw because at the start of the User Guide, it states that items in square brackets are optional.

image.png

Even if they mentioned it under their sort and sorti command section that it is compulsory, this format is still inconsistent with their words in the picture above. In addition, under this section, the format is stated to be "Format: sort f/FIELD o/ORDER" and "Format: sorti INDEX f/FIELD o/ORDER", so the error messages containing the format of the sort and sorti commands should have the same format. Yet this is not the case. image.png image.png

Therefore, since the error message for sort command does not follow the first part of the User Guide and the format specified under the respective command sections, it is considered a FunctionalityBug, not a FeatureFlaw.

## :question: Issue severity Team chose [`severity.VeryLow`] Originally [`severity.Medium`] - [x] I disagree **Reason for disagreement:** This is not just a cosmetic issue, and should not be severity.VeryLow. Due to their inconsistencies in the User Guide, the user may have read the first part of the User Guide and tried to quickly use the application commands by listing out the commands first using the "commands" command, and then typing out the commands to see the format. ![image.png](https://raw.githubusercontent.com/avrilmohh/pe/main/files/36270f05-3122-4318-a270-ef892618bac8.png) If the user types sort without any parameters, this error message will appear, and the user will think that the parameters are optional. ![image.png](https://raw.githubusercontent.com/avrilmohh/pe/main/files/4e1e2795-42ee-4b13-90cf-2383a09985bb.png) Personally, I tried to type "sort f/Alex" and it gave me a Invalid command format! error and I was confused, because I thought the parameters were optional. It only worked when I typed "sort f/Alex o/L". This will cause an inconvenience to the user, but the user can still use the product, after trying the command again or reading the Note: that they added in the sort command section in the User Guide, and this Note: is also not very obvious. Therefore, I think that the severity should at least be Low, and not VeryLow.