dummy_directive - test how directives work¶
New in version 0.4.
This is just what it sounds like - a directive that doesn’t do anything other than (optionally) return a message or raise an error. It is primarially meant for testing the runner or as a placeholder while writing new tasks. Or you can play with it to learn the directive basics.
Parameters¶
Parameter | Required | Description | Type | Default | Choices |
---|---|---|---|---|---|
msg |
no | arbitrary string. If it is present, it is returned. |
anything |
||
result |
yes | arbitrary string. If it equals FAIL (case ignored), then the directive raises an error. |
str |
Return Values¶
Either msg
, if it was provided, or None
.
Exceptions¶
TaskotronDirectiveError
: ifresult="FAIL"
(case ignored)