IRC Socket: documentation cleanup

[user/henk/code/ruby/rbot.git] / lib / rbot / ircsocket.rb

diff --git a/lib/rbot/ircsocket.rb b/lib/rbot/ircsocket.rb
index 6039b9a6f84aa226a4ff68d8528e71481a4f6bf5..496486bb6667591fa5b7175bef13648b38cfa4a2 100644 (file)
--- a/lib/rbot/ircsocket.rb
+++ b/lib/rbot/ircsocket.rb
@@ -1,10 +1,18 @@
+#-- vim:sw=2:et
+#++
+#
+# :title: IRC Socket
+#
+# This module implements the IRC socket interface, including IRC message
+# penalty computation and the message queue system
+
 require 'monitor'
 
 class ::String
   # Calculate the penalty which will be assigned to this message
   # by the IRCd
   def irc_send_penalty
-    # According to eggrdop, the initial penalty is
+    # According to eggdrop, the initial penalty is
     penalty = 1 + self.size/100
     # on everything but UnderNET where it's
     # penalty = 2 + self.size/120