add more help text

modules/AlignmentNewsletterSearch.py

@@ -1,3 +1,7 @@
+"""
+Searches a database of AI-alignment-related documents for something like your question
+"""
+
 from __future__ import annotations
 import re
 from dataclasses import dataclass

modules/Eliza.py

@@ -1,3 +1,7 @@
+"""
+Gives basic responses in the style of a therapy bot. Lower priority than LLM modules.
+"""
+
 import re
 import random
 from modules.module import Module, Response

modules/Factoids.py

@@ -1,3 +1,13 @@
+"""
+Remembers or forgets factoids. Can remember multiple factoids about the same thing
+
+- `remember X is Y`: When asked about X, will reply with Y
+- `remember X <reply> Y`: will always respond to X with Y
+- `forget that`: forgets last factoid given in this channel
+- `list X` or `listall X`: list all responses to a factoid
+"""
+# TODO: let people forget any factoid not given by an admin
+
 import re
 import random
 import sqlite3

modules/Random.py

@@ -1,3 +1,10 @@
+"""
+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
+"""
+
 import re
 import random
 from modules.module import Module, Response

modules/Silly.py

@@ -1,7 +1,9 @@
 """
 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!`
 - XKCD 37: `that's a weird-ass story` -> `that's a weird ass-story`
 - How original: `Welcome our new X` ->

modules/StampyControls.py

@@ -1,3 +1,11 @@
+"""
+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
+"""
+
 import os
 import sys
 from typing import Optional, cast

modules/chatgpt.py

@@ -1,3 +1,7 @@
+"""
+Gives user response to ChatGPT
+"""
+
 from openai.openai_object import OpenAIObject
 import re
 from typing import cast, TYPE_CHECKING

modules/duckduckgo.py

@@ -1,3 +1,10 @@
+"""
+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.
+"""
+
 import re
 import json
 from urllib.parse import quote_plus

modules/gpt3module.py

@@ -1,3 +1,7 @@
+"""
+Gives user response to GPT-3 (old API)
+"""
+
 from typing import Optional, cast
 
 import openai

modules/questions.py

@@ -1,5 +1,6 @@
 """
 Querying question database.
+
 This module is also responsible for automatically posting questions coda questions to channels
 1. `Not started`: Every 6 hours Stampy posts to `#general` a question with status `Not started`, chosen randomly from those that were least recently posted to Discord. Stampy doesn't post, if the last message in `#general` was this kind of autoposted question.
 2. **WIP**: Every Monday, Wednesday, and Friday, sometime between 8 and 12 AM, Stampy posts to `#meta-editing` 1 to 3 questions with status `In review`, `In progress` or `Bulletpoint sketch` that have not been edited for longer than a week. Similarly, he skips if the last message in `#meta-editing` was this one.

modules/reply.py

@@ -1,3 +1,7 @@
+"""
+Curates and posts automated responses to Youtube comments.
+"""
+
 import re
 import json
 import discord

modules/semanticanswers.py

@@ -1,3 +1,7 @@
+"""
+Checks if there are human-written answers to your queston on AIsafety.info
+"""
+
 import re
 import json
 import urllib

modules/sentience.py

@@ -1,3 +1,9 @@
+"""
+The most dangerous module. Only enable if you are an accelerationist
+
+(This module sends a default message at low priority)
+"""
+
 from config import CONFUSED_RESPONSE
 from modules.module import Module, Response
 

modules/stampcollection.py

@@ -1,3 +1,7 @@
+"""
+Manages user rankings through stamps
+"""
+
 from datetime import datetime, timedelta
 import re
 from typing import cast

modules/videosearch.py

@@ -1,3 +1,7 @@
+"""
+Searches the titles, descriptions and transcripts of Rob Miles videos, to find keywords/phrases
+"""
+
 import re
 import os
 from modules.module import Module, Response

modules/why.py

@@ -1,3 +1,12 @@
+"""
+Gives traceback for a specified message.
+
+To use, respond to my message of concern and say "Why did you say that?"
+
+For a much more detailed traceback, respond and say "Why did you say that,
+specifically?"
+"""
+
 import re
 from modules.module import Module, Response
 from utilities.serviceutils import ServiceMessage

modules/wolfram.py

@@ -1,3 +1,8 @@
+"""
+Asks WolframAlpha for the answer
+"""
+
+
 import re
 import urllib
 from config import wolfram_token