VaishakAnand / pe

0 stars 0 forks source link

Wrong Error message output for addAttendance #4

Open VaishakAnand opened 3 years ago

VaishakAnand commented 3 years ago

It shows me details of adding participation when attempting to add attendance with invalid attendance week.

Steps to replicate: 1) Add a module 2) Add a TG 3) Add a Student 4) Attempt to add attendance for a student with an invalid week number, e.g. addAttendance 1 week/2 week/20 5) The following error message is shown:

image.png

nus-se-bot commented 3 years ago

Team's Response

Thanks for your feedback. This error message is from our attendance class which covers both attendance and participation scores.

The error message does serve its purpose in pointing out that "Attendance covers week 1 to 13" which is what is wrong with the tester's input.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: I concede that the error message does mention that 'Attendance covers week 1 to 13', which is indeed what was wrong with the user input. The team mentioned that the error message is from a singular class that covers both attendance and participation scores. I don't believe that is a good enough reason to rule this out as a bug.

Any error message presented by the application should only include what is relevant for the user. In this case, the error lets the user know of the Attendance error (which is not really phrased in a way to alert the user), but also proceeds to talk about participation, which is completely different from what the user input in the first place. Such a message causes confusion, and thus inconvenience to the user, as the user might be led to think that he/she has to provide participation scores as well, and the failure to do that was in fact the cause of the error.

As a result, I believe that this is a valid bug that should be addressed by the developer team.