Add documentation for 8ball command

molly · Oct 24, 2014 · dab5d13 · dab5d13
1 parent b9cbfd7
commit dab5d13
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/plugins/eightball.py b/plugins/eightball.py
@@ -21,6 +21,16 @@
 @command("8ball", "8-ball")
 def eightball(m):
     """Returns 8-ball advice."""
+
+    #-     !8ball [question]
+    #-
+    #- ```irc
+    #- < GorillaWarfare> !8ball
+    #- < GorillaBot> Most likely.
+    #- ```
+    #-
+    #- Returns a magic 8 ball response.
+
     with open(m.bot.base_path + '/plugins/responses/8ball.txt', 'r') as replies:
         lines = replies.read().splitlines()
         m.bot.private_message(m.location, choice(lines))