aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--bot/utils/randomization.py6
1 files changed, 5 insertions, 1 deletions
diff --git a/bot/utils/randomization.py b/bot/utils/randomization.py
index 063d7e1f..8f47679a 100644
--- a/bot/utils/randomization.py
+++ b/bot/utils/randomization.py
@@ -4,7 +4,11 @@ import typing as t
class RandomCycle:
- """Cycling through jumping to random indexes in an iterable."""
+ """
+ Cycles through elements from a randomly shuffled iterable, repeating indefinitely.
+
+ The iterable is reshuffled after each full cycle.
+ """
def __init__(self, iterable: t.Iterable) -> None:
self.iterable = list(iterable)