From: John Runyon <redacted>
Date: Thu, 28 Mar 2024 04:08:10 +0000 (-0600)
Subject: update comments
X-Git-Url: https://jfr.im/git/erebus.git/commitdiff_plain/bac69af4f305607b00110e93f737a248767aa677

update comments
---

diff --git a/modules/admin_channel.py b/modules/admin_channel.py
index d34e0ac..68e15e5 100644
--- a/modules/admin_channel.py
+++ b/modules/admin_channel.py
@@ -1,6 +1,6 @@
 # Erebus IRC bot - Author: Erebus Team
 # vim: fileencoding=utf-8
-# simple module example
+# Channel list management (add, remove channels)
 # This file is released into the public domain; see http://unlicense.org/
 
 # module info
diff --git a/modules/admin_config.py b/modules/admin_config.py
index 7caf6d0..a698e4c 100644
--- a/modules/admin_config.py
+++ b/modules/admin_config.py
@@ -1,6 +1,6 @@
 # Erebus IRC bot - Author: Erebus Team
 # vim: fileencoding=utf-8
-# simple module example
+# Commands to change config file settings
 # This file is released into the public domain; see http://unlicense.org/
 
 # module info
diff --git a/modules/admin_user.py b/modules/admin_user.py
index 3e4a02c..6d215f2 100644
--- a/modules/admin_user.py
+++ b/modules/admin_user.py
@@ -1,6 +1,6 @@
 # Erebus IRC bot - Author: Erebus Team
 # vim: fileencoding=utf-8
-# simple module example
+# Global-user management (glevel)
 # This file is released into the public domain; see http://unlicense.org/
 
 # module info
diff --git a/modules/channel_admin.py b/modules/channel_admin.py
index b8bebc6..1e18d0e 100644
--- a/modules/channel_admin.py
+++ b/modules/channel_admin.py
@@ -1,6 +1,6 @@
 # Erebus IRC bot - Author: Erebus Team
 # vim: fileencoding=utf-8
-# simple module example
+# Channel-access management
 # This file is released into the public domain; see http://unlicense.org/
 
 # module info
diff --git a/modules/eval.py b/modules/eval.py
index c32797a..e5e4399 100644
--- a/modules/eval.py
+++ b/modules/eval.py
@@ -1,6 +1,6 @@
 # Erebus IRC bot - Author: Erebus Team
 # vim: fileencoding=utf-8
-# !EVAL and !EXEC commands
+# !EVAL and !EXEC commands, dangerous! DO NOT USE without understanding the risks!
 # This file is released into the public domain; see http://unlicense.org/
 
 # module info
diff --git a/modules/test_flags.py b/modules/example_flags.py
similarity index 92%
rename from modules/test_flags.py
rename to modules/example_flags.py
index d3268c7..b22ae57 100644
--- a/modules/test_flags.py
+++ b/modules/example_flags.py
@@ -1,6 +1,6 @@
 # Erebus IRC bot - Author: Erebus Team
 # vim: fileencoding=utf-8
-# Various highly recommended "control" commands.
+# An example of the "flags" capability
 # This file is released into the public domain; see http://unlicense.org/
 
 # module info
diff --git a/modules/exception_hook.py b/modules/exception_hook.py
index 28c4c54..78b51ba 100644
--- a/modules/exception_hook.py
+++ b/modules/exception_hook.py
@@ -1,5 +1,6 @@
 # Erebus IRC bot - Author: Erebus Team
 # vim: fileencoding=utf-8
+# A basic exception hook. Sends exceptions to `[exception_hook] destination` in the config.
 # This file is released into the public domain; see http://unlicense.org/
 
 # module info
diff --git a/modules/listenbrainz.py b/modules/listenbrainz.py
index 297f449..81445d1 100644
--- a/modules/listenbrainz.py
+++ b/modules/listenbrainz.py
@@ -1,5 +1,6 @@
 # Erebus IRC bot - Author: Erebus Team
 # vim: fileencoding=utf-8
+# ListenBrainz now-playing
 
 # module info
 modinfo = {
diff --git a/modules/misc.py b/modules/misc.py
index d9aa7ab..4590d8d 100644
--- a/modules/misc.py
+++ b/modules/misc.py
@@ -1,6 +1,6 @@
 # Erebus IRC bot - Author: Erebus Team
 # vim: fileencoding=utf-8
-# simple module example
+# assorted simple functions
 # This file is released into the public domain; see http://unlicense.org/
 
 # module info
diff --git a/modules/msg.py b/modules/msg.py
index 68ca951..5261f4c 100644
--- a/modules/msg.py
+++ b/modules/msg.py
@@ -1,5 +1,6 @@
 # Erebus IRC bot - Author: Erebus Team
 # vim: fileencoding=utf-8
+# Commands to message various destinations
 # This file is released into the public domain; see http://unlicense.org/
 
 # module info
diff --git a/modules/nitterize.py b/modules/nitterize.py
index 07695a3..8a8b095 100644
--- a/modules/nitterize.py
+++ b/modules/nitterize.py
@@ -1,8 +1,6 @@
 # Erebus IRC bot - Author: Erebus Team
 # vim: fileencoding=utf-8
-# module for 's/regex/replacement/' style correction
-# warning: arbitrary regex's are generally capable of various DoS attacks on CPU/memory usage. use with caution.
-# see for usage examples: https://github.com/zonidjan/erebus/commit/d7e9802778477f1faa26a03078cb1b3c018a5e5c
+# nitterize twitter links
 # This file is released into the public domain; see http://unlicense.org/
 
 # module info
diff --git a/modules/resources.py b/modules/resources.py
index 35136a8..5fc4309 100644
--- a/modules/resources.py
+++ b/modules/resources.py
@@ -1,6 +1,6 @@
 # Erebus IRC bot - Author: Erebus Team
 # vim: fileencoding=utf-8
-# resource-usage module
+# resource-usage reporting module
 # This file is released into the public domain; see http://unlicense.org/
 
 # module info
diff --git a/modules/server.py b/modules/server.py
index 691436a..ade5935 100644
--- a/modules/server.py
+++ b/modules/server.py
@@ -1,5 +1,6 @@
 # Erebus IRC bot - Author: Erebus Team
 # vim: fileencoding=utf-8
+# Utility commands to show info like uptime and current server
 # This file is released into the public domain; see http://unlicense.org/
 
 import time
diff --git a/modules/sockets.py b/modules/sockets.py
index cf79e70..f9577e1 100644
--- a/modules/sockets.py
+++ b/modules/sockets.py
@@ -1,9 +1,34 @@
 # Erebus IRC bot - Author: Erebus Team
 # vim: fileencoding=utf-8
+# Configurable sockets module. DO NOT USE without understanding the risks
 # This file is released into the public domain; see http://unlicense.org/
 
 # Note: this module doesn't do any kind of authentication, so anyone who can connect to the bound port can spam you.
 
+"""
+To use - add in bot.config something like:
+
+[sockets]
+127.0.0.1:1337 = #example
+
+The left side is the address to listen on and the right side is the channel to send to.
+The exmaple will send incoming lines/packets on localhost, port 1337 to channel #example
+
+The full syntax for the address is:
+[unix:]</path/to/socket>
+[udp|tcp:][<ip>:]<port>
+
+
+Address examples:
+
+Unix domain socket:          /path
+Unix domain socket:          unix:/path
+TCP socket (all interfaces): 1337
+TCP socket (one interface):  127.0.0.1:1337
+UDP socket (all interfaces): udp:1337
+UDP socket (one interface):  udp:127.0.0.1:1337
+"""
+
 # module info
 modinfo = {
 	'author': 'Erebus Team',
diff --git a/modules/steam.py b/modules/steam.py
index a72f5bf..170b7d4 100644
--- a/modules/steam.py
+++ b/modules/steam.py
@@ -1,5 +1,6 @@
 # Erebus IRC bot - Author: Erebus Team
 # vim: fileencoding=utf-8
+# Steam API commands (!steamnp)
 
 # module info
 modinfo = {
diff --git a/modules/subtext.py b/modules/subtext.py
index c0c0fd1..ca23ec7 100644
--- a/modules/subtext.py
+++ b/modules/subtext.py
@@ -2,7 +2,6 @@
 # vim: fileencoding=utf-8
 # module for 's/regex/replacement/' style correction
 # warning: arbitrary regex's are generally capable of various DoS attacks on CPU/memory usage. use with caution.
-# see for usage examples: https://github.com/zonidjan/erebus/commit/d7e9802778477f1faa26a03078cb1b3c018a5e5c
 # This file is released into the public domain; see http://unlicense.org/
 
 # module info
diff --git a/modules/weatherstack_weather.py b/modules/weatherstack_weather.py
index 937f1dc..d6140d1 100644
--- a/modules/weatherstack_weather.py
+++ b/modules/weatherstack_weather.py
@@ -1,6 +1,6 @@
 # Erebus IRC bot - Author: Erebus Team
 # vim: fileencoding=utf-8
-# weather module
+# weather module (from WeatherStack, boo)
 # This file is released into the public domain; see http://unlicense.org/
 
 # module info