From 7550cc8ae69944eaa6d7b35ee701a1f6d0659f72 Mon Sep 17 00:00:00 2001 From: Migatu Date: Wed, 17 Jan 2024 23:11:46 +0100 Subject: [PATCH] Docstring --- bot.py | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/bot.py b/bot.py index a110b92..8f61cbd 100644 --- a/bot.py +++ b/bot.py @@ -568,7 +568,12 @@ async def check(): async def get_random_cyclic_message(): - messnum = random.randint(0,len(cyclic_words)-1) + """ + The function `get_random_cyclic_message` returns a random cyclic message from a list of cyclic + words. + :return: a random cyclic message from the list `cyclic_words`. + """ + messnum = random.randint(0, len(cyclic_words)-1) return cyclic_words[messnum][0]