update comments

diff --git a/modules/admin_channel.py b/modules/admin_channel.py
index d34e0ac514db224841f5a59ce005b9f69e803ace..68e15e53732e911a6ce642f2b63113d0cf3d03a6 100644 (file)
--- 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 7caf6d06c6250150154af120f5fdc97b4f619926..a698e4c86310f0de90a724656f2820e02e575380 100644 (file)
--- 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 3e4a02c3c0b2601d304f5239c40cbd208415f0f2..6d215f219a117120119ef1019f6b74b4938a4e2e 100644 (file)
--- 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 b8bebc6e9922bee5136ee2809c78c6c4588cd9aa..1e18d0e417b1c70a60ae211dd81114d5fd7b0f96 100644 (file)
--- 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 c32797aab768b624ce10a54435e6843aca1cc41f..e5e4399c1cbf65034569432768f59dd976497899 100644 (file)
--- 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 d3268c70d4fbc34cd8b24adca5d43ee86ba22f86..b22ae576fdaf25579b0db0495507af7eab61aede 100644 (file)
--- 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 28c4c545ca97f9e2118239243d09a877d56af713..78b51bab37d4f79edcc85f40c76b77b012a8ca2d 100644 (file)
--- 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 297f4491de73a8acbfe853698fc2d31a94b55d7c..81445d1ba85ab36e7d8a984a42ab0ab28b59b291 100644 (file)
--- 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 d9aa7abfde0a988e329d7931008db484bdf535d0..4590d8d82823e0d93557b56d99ffe4fafec75aea 100644 (file)
--- 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 68ca951d93e3b00dd0a297144280922a2312c581..5261f4cb555b037832f87fb94cd3945531b85b84 100644 (file)
--- 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 07695a3a220e217efbc457939f0861ae43c4014a..8a8b09596d41f3250b9302cbb4f89ebd5a737a29 100644 (file)
--- 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 35136a810f031afdd67e55c811254f26a245e788..5fc4309a9c135b5c90d0b97daa9c00a8129ec390 100644 (file)
--- 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 691436a4a22e1ee6b09973ad9204d831b7c6cbc2..ade5935b6077336e14dc83b0fb14482ca445f6aa 100644 (file)
--- 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 cf79e70d36a912fc8e100e6936062cef8ec9e1a0..f9577e18fbbee6eb70f0941d86720624bd6237ca 100644 (file)
--- 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 a72f5bf9d47eab65a1365fb668fd172f9ad5b829..170b7d485502719535caadd29667f4f2cccb139b 100644 (file)
--- 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 c0c0fd1ec2c768a812aefd2aa86a0b74961f0e03..ca23ec7dda620f4d1aedb75a0d436e8e0d4b3b21 100644 (file)
--- 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 937f1dc19b905a7e85799cd63c43a9a59c18f3dc..d6140d131367dfd3cdfb29d72c550f950268a77b 100644 (file)
--- 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