updated karma plugin docstrings so that autogenerated documentation is consistent

Author: edillingham

plugins/karma.py

@@ -22,7 +22,7 @@ def db_init(db, conn_name):
 
 @hook.command("pp", "addpoint")
 def addpoint(text, nick, chan, db, conn):
-    """.addpoint or (.pp) <thing> adds a point to the <thing>"""
+    """<thing> - adds a point to the <thing>"""
     text = text.strip()
     db_init(db, conn.name)
     karma = db.execute("select score from karma where name = :name and chan = :chan and thing = :thing", {'name': nick, 'chan': chan, 'thing': text.lower()}).fetchone()
@@ -51,7 +51,7 @@ def re_addpt(match, nick, chan, db, conn, notice):
 
 @hook.command("mm", "rmpoint")
 def rmpoint(text, nick, chan, db, conn):
-    """.rmpoint or (.mm) <thing> subtracts a point from the <thing>"""
+    """<thing> - subtracts a point from the <thing>"""
     text = text.strip()
     db_init(db, conn.name)
     karma = db.execute("select score from karma where name = :name and chan = :chan and thing = :thing", {'name': nick, 'chan': chan, 'thing': text.lower()}).fetchone()
@@ -69,7 +69,7 @@ def rmpoint(text, nick, chan, db, conn):
 
 @hook.command("pluspts", autohelp=False)
 def pluspts(nick, chan, db, conn):
-    """prints the things you have liked and their scores"""
+    """- prints the things you have liked and their scores"""
     db_init(db, conn.name)
     output = ""
     likes = db.execute("select thing, score from karma where name = :name and chan = :chan and score >= 0 order by score desc", {'name': nick, 'chan': chan}).fetchall()
@@ -80,7 +80,7 @@ def pluspts(nick, chan, db, conn):
 
 @hook.command("minuspts", autohelp=False)
 def minuspts(nick, chan, db, conn):
-    """prints the things you have disliked and their scores"""
+    """- prints the things you have disliked and their scores"""
     db_init(db, conn.name)
     output = ""
     likes = db.execute("select thing, score from karma where name = :name and chan = :chan and score <= 0 order by score", {'name': nick, 'chan': chan}).fetchall()
@@ -102,7 +102,7 @@ def re_rmpt(match, nick, chan, db, conn, notice):
 
 @hook.command("points", autohelp=False)
 def points(text, chan, db, conn):
-    """.points <thing> will print the total points for <thing> in the channel."""
+    """<thing> - will print the total points for <thing> in the channel."""
     db_init(db, conn.name)
     score = 0
     karma = ""
@@ -131,7 +131,7 @@ def points(text, chan, db, conn):
 
 @hook.command("topten", "pointstop", "loved", autohelp=False)
 def pointstop(text, chan, db, message, conn, notice):
-    """.topten or .pointstop or .loved prints the top 10 things with the highest points in the channel. To see the top 10 items in all of the channels the bot sits in use .topten global."""
+    """- prints the top 10 things with the highest points in the channel. To see the top 10 items in all of the channels the bot sits in use .topten global."""
     db_init(db, conn.name)
     scores = []
     points = defaultdict(int)
@@ -162,7 +162,7 @@ def pointstop(text, chan, db, message, conn, notice):
 
 @hook.command("bottomten", "pointsbottom", "hated", autohelp=False)
 def pointsbottom(text, chan, db, message, conn, notice):
-    """.bottomten or .pointsbottom or .hated prints the top 10 things with the lowest points in the channel. To see the bottom 10 items in all of the channels the bot sits in use .bottomten global."""
+    """- prints the top 10 things with the lowest points in the channel. To see the bottom 10 items in all of the channels the bot sits in use .bottomten global."""
     db_init(db, conn.name)
     scores = []
     points = defaultdict(int)