aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGravatar kwzrd <[email protected]>2020-08-27 10:07:23 +0200
committerGravatar kwzrd <[email protected]>2020-08-27 10:07:23 +0200
commit0ba23a7c47813280ab6157396e43d61e8fc7b4d2 (patch)
tree1dbf75e36fd6422698d0fe2b26c75f20efb52b61
parentVerification: stop kicking members on suspicious 403 (diff)
Verification: document StopExecution handling
-rw-r--r--bot/cogs/verification.py3
1 files changed, 3 insertions, 0 deletions
diff --git a/bot/cogs/verification.py b/bot/cogs/verification.py
index 196808b0d..984f3cc95 100644
--- a/bot/cogs/verification.py
+++ b/bot/cogs/verification.py
@@ -272,6 +272,9 @@ class Verification(Cog):
This coroutine serves as a generic `request` executor for kicking members and adding
roles, as it allows us to define the error handling logic in one place only.
+ Any `request` has the ability to completely abort the execution by raising `StopExecution`.
+ In such a case, the @Admins will be alerted of the reason attribute.
+
To avoid rate-limits, pass a `limit` configuring the batch size and the amount of seconds
to sleep between batches.