#1229 document reason strings in policies
Merged by mikem. Opened by tkopecek.
tkopecek/koji issue1228  into  master

Download 1229.patch

Fixes: https://pagure.io/koji/issue/1228

:thumbsup:

-    test [params] [&& test [params] ...] :: action-if-true
-    test [params] [&& test [params] ...] !! action-if-false
+    test [params] [&& test [params] ...] :: action-if-true [reason]
+    test [params] [&& test [params] ...] !! action-if-false [reason]

Not all actions accept a reason argument. This only applies for allow/deny policies (i.e. those called through check_policy or assert_policy). It is not correct to say that users can add a reason arg to any action. You certainly cannot do this in the channel policy, for example.

rebased onto fa38c79a8054cc551ac3c4c83d2e8309545138eb

Removed reason string from general syntax (+rebase).

Commit e143da90 fixes this pull-request

Pull-Request has been merged by mikem

Metadata