From 6f116de3b8b3cceca4ad6cba1539ebedd7db0821 Mon Sep 17 00:00:00 2001 From: Producer Matt <58014742+ProducerMatt@users.noreply.github.com> Date: Mon, 3 Jul 2023 18:35:35 -0500 Subject: [PATCH] try to comply with help module docstring requirements --- modules/Random.py | 9 +++++++-- modules/Silly.py | 4 +--- modules/StampyControls.py | 14 +++++++++++--- modules/duckduckgo.py | 4 +--- modules/sentience.py | 4 +++- modules/why.py | 9 ++++++--- 6 files changed, 29 insertions(+), 15 deletions(-) diff --git a/modules/Random.py b/modules/Random.py index e961ad3..25bcbd8 100644 --- a/modules/Random.py +++ b/modules/Random.py @@ -1,8 +1,13 @@ """ Generates random numbers or chooses between options. -- `roll XdY`: roll X dies with Y sides -- `choose X or Y (or Z or...)`: choose between as many options as are given +Roll dice +roll X dies with Y sides +`roll XdY` + +Make a choice +choose between as many options as are given +`choose X or Y (or Z or...)` """ import re diff --git a/modules/Silly.py b/modules/Silly.py index 73ffc55..1ef66b6 100644 --- a/modules/Silly.py +++ b/modules/Silly.py @@ -1,7 +1,5 @@ """ -Provides quirky responses for some pre-programmed cases, most unprompted. - -If a message from this module interrupts a desired behavior, re-send your +Provides quirky responses for some pre-programmed cases, most unprompted. If a message from this module interrupts a desired behavior, re-send your previous message and the joke won't trigger. - `s, say X`: `X!` diff --git a/modules/StampyControls.py b/modules/StampyControls.py index 06e746d..f31b9e8 100644 --- a/modules/StampyControls.py +++ b/modules/StampyControls.py @@ -1,9 +1,17 @@ """ Allows devs to manage some Stampy functions -- `reboot`: reboot Stampy according to `BOT_REBOOT` -- `stats`: Stats about Stampy -- `resetinviteroles`: reset the roles for people with invitation permissions +Reboot +Reboot Stampy according to `BOT_REBOOT` +`reboot` + +Stats +Stats about Stampy, like resource usage and modules loaded +`stats` + +Reset invite roles +reset the roles for people with invitation permissions +`resetinviteroles` """ import os diff --git a/modules/duckduckgo.py b/modules/duckduckgo.py index 60be970..877bcf3 100644 --- a/modules/duckduckgo.py +++ b/modules/duckduckgo.py @@ -1,7 +1,5 @@ """ -Checks if DuckDuckGo has a definition for what you're asking about. - -For example, "what is linear algebra" will get the first paragraph of the +Checks if DuckDuckGo has a definition for what you're asking about. For example, "what is linear algebra" will get the first paragraph of the Wikipedia article for linear algebra. """ diff --git a/modules/sentience.py b/modules/sentience.py index 9ff66a6..2ec5508 100644 --- a/modules/sentience.py +++ b/modules/sentience.py @@ -1,7 +1,9 @@ """ The most dangerous module. Only enable if you are an accelerationist -(This module sends a default message at low priority) +The dark truth +This module sends a default message at low priority +`s, ` """ from config import CONFUSED_RESPONSE diff --git a/modules/why.py b/modules/why.py index 8d44e61..a00ddaf 100644 --- a/modules/why.py +++ b/modules/why.py @@ -1,10 +1,13 @@ """ Gives traceback for a specified message. -To use, respond to my message of concern and say "Why did you say that?" +Basic traceback +Give a brief summary of why the message you're responding to was sent. +`why did you say this?` -For a much more detailed traceback, respond and say "Why did you say that, -specifically?" +Detailed traceback +Give a long and detailed explanation of Stampy's thought process. +"Why did you say that, specifically?" """ import re