Fix docstrings to satisfy the new tests

Author: linuxdaemon

plugins/admin_bot.py

@@ -369,7 +369,7 @@ def me(text, conn, chan, message, nick, admin_log):
 @asyncio.coroutine
 @hook.command(autohelp=False, permissions=["botcontrol"])
 def listchans(conn, chan, message, notice):
-    """-- Lists the current channels the bot is in"""
+    """- Lists the current channels the bot is in"""
     chans = ', '.join(sorted(conn.channels, key=lambda x: x.strip('#').lower()))
     lines = formatting.chunk_str("I am currently in: {}".format(chans))
     for line in lines:

plugins/cryptocurrency.py

@@ -67,7 +67,7 @@ def init_aliases():
 # main command
 @hook.command("crypto", "cryptocurrency")
 def crypto_command(text, reply):
-    """ <ticker> [currency] -- Returns current value of a cryptocurrency """
+    """<ticker> [currency] - Returns current value of a cryptocurrency"""
     args = text.split()
     ticker = args.pop(0)
 

plugins/drinks.py

@@ -15,7 +15,7 @@ def load_drinks(bot):
 
 @hook.command()
 def drink(text, chan, action):
-    """<nick>, makes the user a random cocktail."""
+    """<nick> - makes the user a random cocktail."""
     index = random.randint(0,len(drinks)-1)
     drink = drinks[index]['title']
     url = web.try_shorten(drinks[index]['url'])

plugins/geoip.py

@@ -76,7 +76,7 @@ def load_geoip(loop):
 @asyncio.coroutine
 @hook.command
 def geoip(text, reply, loop):
-    """ geoip <host|ip> -- Looks up the physical location of <host|ip> using Maxmind GeoLite """
+    """<host|ip> - Looks up the physical location of <host|ip> using Maxmind GeoLite """
     global geoip_reader
 
     if not geoip_reader:

plugins/piglatin.py

@@ -67,7 +67,7 @@ def load_nltk():
 
 @hook.command("pig", "piglatin")
 def piglatin(text):
-    """ pig <text> -- Converts <text> to pig latin. """
+    """<text> - Converts <text> to pig latin."""
     global pronunciations
     if not pronunciations:
         return "Please wait, getting NLTK ready!"
@@ -94,4 +94,4 @@ def piglatin(text):
     if text.isupper():
         return " ".join(words).upper()
     else:
-        return " ".join(words)
+        return " ".join(words)

plugins/profile.py

@@ -87,7 +87,7 @@ def moreprofile(text, chan, nick, notice):
 
 @hook.command()
 def profile(text, chan, notice, nick):
-    """<nick> [category] Returns a user's saved profile data from \"<category>\", or lists all available profile categories for the user if no category specified"""
+    """<nick> [category] - Returns a user's saved profile data from \"<category>\", or lists all available profile categories for the user if no category specified"""
     chan_cf = chan.casefold()
     nick_cf = nick.casefold()
 
@@ -133,7 +133,7 @@ def profile(text, chan, notice, nick):
 
 @hook.command()
 def profileadd(text, chan, nick, notice, db):
-    """<category> <content> Adds data to your profile in the current channel under \"<category>\""""
+    """<category> <content> - Adds data to your profile in the current channel under \"<category>\""""
     if nick.casefold() == chan.casefold():
         return "Profile data can not be set outside of channels"
 
@@ -163,7 +163,7 @@ def profileadd(text, chan, nick, notice, db):
 
 @hook.command()
 def profiledel(nick, chan, text, notice, db):
-    """<category> Deletes \"<category>\" from a user's profile"""
+    """<category> - Deletes \"<category>\" from a user's profile"""
     if nick.casefold() == chan.casefold():
         return "Profile data can not be set outside of channels"
 

plugins/time_plugin.py

@@ -44,7 +44,7 @@ def load_key(bot):
 
 @hook.command("time")
 def time_command(text, reply):
-    """<location> -- Gets the current time in <location>."""
+    """<location> - Gets the current time in <location>."""
     if not dev_key:
         return "This command requires a Google Developers Console API key."
 
@@ -110,7 +110,7 @@ def time_command(text, reply):
 
 @hook.command(autohelp=False)
 def beats(text):
-    """ -- Gets the current time in .beats (Swatch Internet Time). """
+    """- Gets the current time in .beats (Swatch Internet Time)."""
 
     if text.lower() == "wut":
         return "Instead of hours and minutes, the mean solar day is divided " \

plugins/wyr.py

@@ -46,7 +46,7 @@ def get_wyr(headers):
 
 @hook.command("wyr", "wouldyourather", autohelp=False)
 def wyr(bot):
-    """ -- What would you rather do? """
+    """- What would you rather do?"""
     headers = {"User-Agent": bot.user_agent}
 
     # keep trying to get entries until we find one that is not filtered