search

jamieeeleow / pe

0 stars 0 forks source link

Error message when module is valid #9

Open jamieeeleow opened 1 year ago

jamieeeleow commented 1 year ago

image.png

I was given an error when my module of code CS1231 is valid.

nus-pe-bot commented 1 year ago

Team's Response

You have typed the command wrongly. If you have time included in the command, then you are tagging a lesson corresponding to a module together to a person. Therefore, you are missing the Day attribute.

Please take a look at our UG on the tag command format (the 4th bullet point). You will notice that the command you have typed is invalid.

image.png

Furthermore, we have also stated in our DG, under Planned Enhancements (point 6) that we will be giving "More explicit feedback messages for tag and untag commands for users." to give them more specific error messages for tag/untag command.

Either way, this should not be a High severity issue because "only problems that make the product almost unusable for most users should have this label." (from the CS2103 website). Instead, it should be a Low severity issue because the user is expected to read the UG if they are unsure how to use a command.

Items for the Tester to Verify

:question: Issue response

Team chose [response.NotInScope]

Reason for disagreement: Sorry for the confusion that I am missing the day attribute, but I believe that this confusion only arise because of the error message. The error message should instead prompt me that I am missing the day attribute instead of prompting me that my module is wrong.

This confusion exactly proves that the error message should be improved so that user will understand what actually went wrong with the command.

## :question: Issue severity Team chose [`severity.Low`] Originally [`severity.High`] - [x] I disagree **Reason for disagreement:** I believe this should be compromised to a medium severity. I understand that users are expected to read the user guide if they are unsure of how to use the guide, however as per ur screenshot showing the attributes, it can be seen that there are many commands available with similar style of command and different attributes to be keyed in, it will definitely take time getting used to it. I think that the purpose of the error message is that when there are small mistakes and errors in the input of users, the error message will help to remind them what went wrong and they can quickly correct their input instead of scrolling through the user guide and troubleshooting by themselves, looking through the commands again and comparing word for word wondering what they are missing. Hence if there is an error message, it should be clearer and more targeted at the error.