aaronliwh / pe

0 stars 0 forks source link

Inconsistent description of command requirements #16

Open aaronliwh opened 1 year ago

aaronliwh commented 1 year ago

image.png

User guide states "The index must be within the number of questions in the question list" for the mark question command. This requirement is not repeated for the analogous commands for helping/unhelping students or marking/unmarking tutorials, even though it is still required.

nus-se-script commented 1 year ago

Team's Response

it is not a documentation bug as it is not a flaw in the documentation, it is more of an improvement of UG

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: The one of the purposes of the UG is to describe the limitations of the command. The limitation of "The index must be within the number of questions in the question list" is not described for helping/unhelping students.


:question: Issue severity

Team chose [severity.VeryLow] Originally [severity.Low]

Reason for disagreement: While this error is not very severe, it is not purely cosmetic and thus should be at least low.