RyanNgWH / pe

0 stars 0 forks source link

Error message for index is not specific #10

Open RyanNgWH opened 2 months ago

RyanNgWH commented 2 months ago

image.png

The error message simply states that the index is invalid. It does not specify what makes the index invalid.

image.png

The UG only states that "The index must be a positive integer 1, 2, 3, …", based on this, it seems that 9 should be a valid index, however, it is not since there is no person in the application with index 9

nus-pe-bot commented 2 months ago

Team's Response

Thank you for pointing that out. Indeed, the UG should state that the index must be a both a positive integer and also less than or equal to the number of people listed in the application.

However, this is simply a typo in the UG (the app still correctly reflects that 9 is an invalid index), thus we think this is a very low severity issue.

Items for the Tester to Verify

:question: Issue type

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

Reason for disagreement: [replace this with your explanation]


## :question: Issue severity Team chose [`severity.VeryLow`] Originally [`severity.Low`] - [x] I disagree **Reason for disagreement:** I agree with the team that this would be a documentation bug instead of a feature flaw like I originally reported. ![image.png](https://raw.githubusercontent.com/RyanNgWH/pe/main/files/78108337-dd5c-4f14-a51e-2352aa200eca.png) However, based on the the descriptions of a `very low` and `low` bug, I do not believe that this is simply a "purely cosmetic" issue. A purely cosmetic issue would be something like a simple typo, however, I believe that this issue is not a typo but leans more towards missing information from the UG which does in fact affect the user's ability to understand what the error was. I do believe that this issue "appears only in very rare situations and causes a minor inconvenience only" and constitutes for a `low` severity instead of a `very low` severity as the team suggests.