Merge pull request #146 from python-discord/flake8-docstring

Implement flake8-docstrings

1 files changed, 9 insertions, 4 deletions

diff --git a/bot/seasons/valentines/myvalenstate.py b/bot/seasons/valentines/myvalenstate.py
index 7d9f3a59..0ea8fbab 100644
--- a/bot/seasons/valentines/myvalenstate.py
+++ b/bot/seasons/valentines/myvalenstate.py
@@ -15,14 +15,15 @@ with open(Path('bot', 'resources', 'valentines', 'valenstates.json'), 'r') as fi
     STATES = json.load(file)
 
 
-class MyValenstate(commands.Cog):
+class MyValenstate:
+    """A Cog to find your most likely Valentine's vacation destination."""
+
     def __init__(self, bot):
         self.bot = bot
 
     def levenshtein(self, source, goal):
-        """
-        Calculates the Levenshtein Distance between source and goal.
-        """
+        """Calculates the Levenshtein Distance between source and goal."""
+
         if len(source) < len(goal):
             return self.levenshtein(goal, source)
         if len(source) == 0:
@@ -43,6 +44,8 @@ class MyValenstate(commands.Cog):
 
     @commands.command()
     async def myvalenstate(self, ctx, *, name=None):
+        """Find the vacation spot(s) with the most matching characters to the invoking user."""
+
         eq_chars = collections.defaultdict(int)
         if name is None:
             author = ctx.message.author.name.lower().replace(' ', '')
@@ -81,5 +84,7 @@ class MyValenstate(commands.Cog):
 
 
 def setup(bot):
+    """Valenstate Cog load."""
+
     bot.add_cog(MyValenstate(bot))
     log.info("MyValenstate cog loaded")