Abhiman2211 / pe

0 stars 0 forks source link

Documentation Bug with Rule Feature #6

Open Abhiman2211 opened 4 years ago

Abhiman2211 commented 4 years ago

When trying to follow the rule adding example provided in the user guide, I run into an error message.

Screenshot 2019-11-15 at 5.00.33 PM.png

Screenshot 2019-11-15 at 5.00.51 PM.png

By right all examples provided in the user guide should be working. Moreover, the user guide does not cover why such an error might occur, how to handle it or even how to add more rules when such an error is faced.

nus-pe-bot commented 4 years ago

Team's Response

Thank you for reviewing.

However. The example does work. This is an example of how to specify a rule with a script as a predicate. In this case, example states the script named "IsMonthlyAllowance". Of course, the script needs to exist first. Our example assumes that you have such a script, rather than define that script for you. Therefore the example does not have any issue.

Moreover, the user guide does not cover why such an error might occur, how to handle it

The reason why is specified pretty clearly in the command output: Screenshot 2019-11-17 at 00.08.17.png

I think the error is pretty self-explanatory, that a script named "IsMonthlyAllowance" needs to exist. If we covered every single error that might occur, the user guide would be inordinately long.

As for "how to handle it", since our target audience is computing students, they should be more than capable of writing and adding such a script with our scripting API.

or even how to add more rules when such an error is faced.

Adding rules is very clearly stated in the User Guide. There is nothing preventing the addition of more rules when this happens.

Note: In any case, reduced severity to low as the explanation for the example is extremely self explanatory.

Items for the Tester to Verify

:question: Issue response

Team chose [response.Rejected]

Reason for disagreement: [replace this with your reason]


:question: Issue severity

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

Reason for disagreement: [replace this with your reason]