clean docstrings for commands, resolves #1

cogs/lovehate.py

@@ -29,12 +29,6 @@ class LoveHate(commands.Cog):
     async def loves(self, ctx, user: Optional[str] = None) -> None:
         """
         If keyword isn't provided, returns the things YOU love; specify a user to find what THEY love.
-        
-        Args:
-            ctx (Any)
-            user (Optional[str])
-        Returns:
-            None 
         """
         try:
             if not user:
@@ -68,12 +62,6 @@ class LoveHate(commands.Cog):
     async def wholoves(self, ctx, *, thing: Optional[str] = None) -> None:
         """
         Check who loves <thing>
-        
-        Args:
-            ctx (Any)
-            thing (Optional[str])
-        Returns:
-            None
         """
         try:
             if not thing:
@@ -118,12 +106,6 @@ class LoveHate(commands.Cog):
     async def whohates(self, ctx, *, thing: Optional[str] = None) -> None:
         """
         Check who hates <thing>
-        
-        Args:
-            ctx (Any)
-            thing (Optional[str])
-        Returns:
-            None
         """
         try:
             if not thing:
@@ -167,12 +149,6 @@ class LoveHate(commands.Cog):
     async def dontcare(self, ctx, thing: str) -> None:
         """
         Make me forget your opinion on <thing>
-        
-        Args:
-            ctx (Any)
-            thing (str)
-        Returns:
-            None
         """
         try:
             stop_caring: str = await self.db.update(ctx.author.display_name,
@@ -186,12 +162,6 @@ class LoveHate(commands.Cog):
     async def hates(self, ctx, user: Optional[str] = None) -> None:
         """
         If keyword isn't provided, returns the things YOU hate; specify a user to find what THEY hate.
-        
-        Args:
-            ctx (Any)
-            user (Optional[str])
-        Returns:
-            None 
         """
         try:
             if not user:
@@ -222,12 +192,6 @@ class LoveHate(commands.Cog):
     async def love(self, ctx, *, thing: str) -> None:
         """
         Love <thing>
-        
-        Args:
-            ctx (Any)
-            thing (str)
-        Returns:
-            None
         """
         try:
             if discord.utils.raw_mentions(thing):
@@ -252,12 +216,6 @@ class LoveHate(commands.Cog):
     async def hate(self, ctx, *, thing: str) -> None:
         """
         Hate <thing>
-        
-        Args:
-            ctx (Any)
-            thing (str)
-        Returns:
-            None
         """
         try:
             if discord.utils.raw_mentions(thing):

cogs/misc.py

@@ -109,11 +109,6 @@ class Misc(commands.Cog):
     async def stats(self, ctx) -> None:
         """
         Get Stats
-        
-        Args:
-            ctx (Any)
-        Returns:
-            None
         """
         try:
             stats_embed: Optional[discord.Embed] = await self.util.get_stats_embed()
@@ -129,11 +124,6 @@ class Misc(commands.Cog):
     async def listcoffees(self, ctx) -> None:
         """
         List Available Coffees
-        
-        Args:
-            ctx (Any)
-        Returns:
-            None
         """
         coffees: str = ""
         try:
@@ -151,11 +141,6 @@ class Misc(commands.Cog):
     async def listshoves(self, ctx) -> None:
         """
         List Available Fates for shove command
-        
-        Args:
-            ctx (Any)
-        Returns:
-            None 
         """
         fates: str = ""
         try:
@@ -173,11 +158,6 @@ class Misc(commands.Cog):
     async def xmas(self, ctx) -> None:
         """
         Countdown til xmas!
-        
-        Args:
-            ctx (Any)
-        Returns:
-            None  
         """
         try:
             emojis: dict = {
@@ -218,11 +198,6 @@ class Misc(commands.Cog):
     async def randfact(self, ctx) -> None:
         """
         Get a random (useless) fact!
-        
-        Args:
-            ctx (Any)
-        Returns:
-            None
         """
         try:
             with ctx.channel.typing():
@@ -238,12 +213,6 @@ class Misc(commands.Cog):
                      recipient: Optional[str] = None) -> None:
         """
         Insult Someone (or yourself)
-        
-        Args:
-            ctx (Any)
-            recipient (Optional[str])
-        Returns:
-            None
         """
         try:
             guild: Optional[discord.Guild] = self.bot.get_guild(ctx.guild.id)
@@ -279,13 +248,6 @@ class Misc(commands.Cog):
                      language: Optional[str] = 'en') -> None:
         """
         Compliment someone (or yourself)
-        
-        Args:
-            ctx (Any)
-            recipient (Optional[str])
-            language (Optional[str]) (default: 'en')
-        Returns:
-            None
         """
         try:
             authorDisplay: str = ctx.author.display_name if not(ctx.author.display_name is None)\
@@ -320,12 +282,6 @@ class Misc(commands.Cog):
                      recipient: Optional[str] = None) -> None:
         """
         Get a whisky for yourself or a friend!
-        
-        Args:
-            ctx (Any)
-            recipient (Optional[str])
-        Returns:
-            None
         """
         try:
             if not recipient:
@@ -364,12 +320,6 @@ class Misc(commands.Cog):
                     recipient: Optional[str] = None) -> None:
         """
         Get a cocktail for yourself or a friend!
-        
-        Args:
-            ctx (Any)
-            recipient (Optional[str])
-        Returns:
-            None
         """
         try:
             if not recipient:
@@ -412,12 +362,6 @@ class Misc(commands.Cog):
                     recipient: Optional[str] = None) -> None:
         """
         Spray someone with water!
-        
-        Args:
-            ctx (Any)
-            recipient (Optional[str])
-        Returns:
-            None
         """
         authorDisplay: str = ctx.author.display_name if not(ctx.author.display_name is None)\
             else ctx.message.author.display_name
@@ -452,12 +396,6 @@ class Misc(commands.Cog):
                       recipient: Optional[str] = None) -> None:
         """
         Pass someone (or yourself) a barf bag!
-        
-        Args:
-            ctx (Any)
-            recipient (Optional[str])
-        Returns:
-            None
         """
         authorDisplay: str = ctx.author.display_name if not(ctx.author.display_name is None)\
             else ctx.message.author.display_name
@@ -492,11 +430,6 @@ class Misc(commands.Cog):
                   recipient: Optional[str] = None) -> None:
         """
         Tea!
-        
-        Args:
-            recipient (Optional[str])
-        Returns:
-            None
         """
         tea: str = "a cup of tea"
         
@@ -548,12 +481,6 @@ class Misc(commands.Cog):
                      message: str) -> None:
         """
         Cowsay!
-        
-        Args:
-            ctx (Any)
-            message (str)
-        Returns:
-            None
         """    
         try:
             cowfile: str = random.choice(self.COWS).replace(".cow", "")
@@ -571,11 +498,6 @@ class Misc(commands.Cog):
                       cowfile: Optional[str] = None) -> None:
         """
         Fortune | Cowsay!
-        
-        Args:
-            cowfile (Optional[str])
-        Returns:
-            None 
         """
         try:
             if not cowfile:
@@ -597,11 +519,6 @@ class Misc(commands.Cog):
     async def listcows(self, ctx) -> None:
         """
         List available .cow files (for cowsay)
-        
-        Args:
-            ctx (Any)
-        Returns:
-            None
         """
         cow_list: str = ""
         try:
@@ -621,12 +538,6 @@ class Misc(commands.Cog):
                       recipient: Optional[str] = None) -> None:
         """
         Cyanide!
-        
-        Args:
-            ctx (Any)
-            recipient (Optional[str])
-        Returns:
-            None
         """
         authorDisplay: str = ctx.author.display_name if not(ctx.author.display_name is None)\
             else ctx.message.author.display_name
@@ -667,12 +578,6 @@ class Misc(commands.Cog):
                     recipient: Optional[str] = None) -> None:
         """
         School gravy!  (It's deadly)
-        
-        Args:
-            ctx (Any)
-            recipient (Optional[str])
-        Returns:
-            None
         """
         authorDisplay: str = ctx.author.display_name if not(ctx.author.display_name is None)\
             else ctx.message.author.display_name
@@ -713,12 +618,6 @@ class Misc(commands.Cog):
                     recipient: Optional[str] = None) -> None:
         """
         Cold water! Drink up.
-        
-        Args:
-            ctx (Any)
-            recipient (Optional[str])
-        Returns:
-            None
         """
         authorDisplay: str = ctx.author.display_name if not(ctx.author.display_name is None)\
             else ctx.message.author.display_name
@@ -758,12 +657,6 @@ class Misc(commands.Cog):
                     recipient: Optional[str] = None) -> None:
         """
         Shove someone! (Or yourself)
-        
-        Args:
-            ctx (Any)
-            recipient (Optional[str])
-        Returns:
-            None
         """
         chosen_fate: str = random.choice(self.FATES)
         
@@ -800,12 +693,6 @@ class Misc(commands.Cog):
                      recipient: Optional[str] = None) -> None:
         """
         Coffee!
-        
-        Args:
-            ctx (Any)
-            recipient (Optional[str])
-        Returns:
-            None
         """
         
         recipient_allergic: bool = False
@@ -853,12 +740,6 @@ class Misc(commands.Cog):
                      recipient: Optional[str] = None) -> None:
         """
         Cookies!
-        
-        Args:
-            ctx (Any)
-            recipient (Optional[str])
-        Returns:
-            None
         """
         authorDisplay: str = ctx.author.display_name if not(ctx.author.display_name is None)\
             else ctx.message.author.display_name
@@ -898,12 +779,6 @@ class Misc(commands.Cog):
                         recipient: Optional[str] = None) -> None:
         """
         Hashbrowns!
-        
-        Args:
-            ctx (Any)
-            recipient (Optional[str])
-        Returns:
-            None
         """
         authorDisplay: str = ctx.author.display_name if not(ctx.author.display_name is None)\
             else ctx.message.author.display_name
@@ -938,12 +813,6 @@ class Misc(commands.Cog):
                        recipient: Optional[str] = None) -> None:
         """
         Ritalini!
-        
-        Args:
-            ctx (Any)
-            recipient (Optional[str])
-        Returns:
-            None
         """
         authorDisplay = ctx.author.display_name if not(ctx.author.display_name is None)\
             else ctx.message.author.display_name
@@ -980,12 +849,6 @@ class Misc(commands.Cog):
                             recipient: Optional[str] = None) -> None:
         """
         Grilled Cheese!
-        
-        Args:
-            ctx (Any)
-            recipient (Optional[str])
-        Returns:
-            None
         """
         authorDisplay: str = ctx.author.display_name if not(ctx.author.display_name is None)\
             else ctx.message.author.display_name
@@ -1020,12 +883,6 @@ class Misc(commands.Cog):
                    recipient: Optional[str] = None) -> None:
         """
         Soup!
-        
-        Args:
-            ctx (Any)
-            recipient (Optional[str])
-        Returns:
-            None
         """
         authorDisplay: str = ctx.author.display_name if not(ctx.author.display_name is None)\
             else ctx.message.author.display_name
@@ -1060,12 +917,6 @@ class Misc(commands.Cog):
                      recipient: Optional[str] = None) -> None:
         """
         Muffins!
-        
-        Args:
-            ctx (Any)
-            recipient (Optional[str])
-        Returns:
-            None
         """
         authorDisplay: str = ctx.author.display_name if not(ctx.author.display_name is None)\
             else ctx.message.author.display_name
@@ -1105,12 +956,6 @@ class Misc(commands.Cog):
                     recipient: Optional[str] = None) -> None:
         """
         Bacon!
-        
-        Args:
-            ctx (Any)
-            recipient (Optional[str])
-        Returns:
-            None
         """
         authorDisplay: str = ctx.author.display_name if not(ctx.author.display_name is None)\
             else ctx.message.author.display_name
@@ -1150,12 +995,6 @@ class Misc(commands.Cog):
                    recipient: Optional[str] = None) -> None:
         """
         Hang someone!
-        
-        Args:
-            ctx (Any)
-            recipient (Optional[str])
-        Returns:
-            None
         """
         authorDisplay = ctx.author.display_name if not(ctx.author.display_name is None)\
             else ctx.message.author.display_name
@@ -1196,12 +1035,6 @@ class Misc(commands.Cog):
                     recipient: Optional[str] = None) -> None:
         """
         Touch someone!
-        
-        Args:
-            ctx (Any)
-            recipient (Optional[str])
-        Returns:
-            None
         """
         guild: Optional[discord.Guild] = self.bot.get_guild(ctx.guild.id)
         if not guild:
@@ -1249,11 +1082,6 @@ class Misc(commands.Cog):
     async def qajoke(self, ctx) -> None:
         """
         Get a joke in Q/A Form!
-        
-        Args:
-            ctx (Any)
-        Returns:
-            None
         """
         try:
             qajoke: Optional[tuple] = await self.util.get_qajoke()
@@ -1273,11 +1101,6 @@ class Misc(commands.Cog):
     async def rjoke(self, ctx) -> None:
         """
         Get a joke! (from r/jokes scrape)
-        
-        Args:
-            ctx (Any)
-        Returns;
-            None 
         """
         try:
             rjoke: Optional[tuple] = await self.util.get_rjoke()
@@ -1300,12 +1123,6 @@ class Misc(commands.Cog):
                     recipient: Optional[str] = None) -> None:
         """
         Joints!
-        
-        Args:
-            ctx (Any)
-            recipient (Optional[str])
-        Returns:
-            None
         """
         authorDisplay: str = ctx.author.display_name if not(ctx.author.display_name is None)\
             else ctx.message.author.display_name
@@ -1348,11 +1165,6 @@ class Misc(commands.Cog):
     async def isitfriday(self, ctx) -> None:
         """
         IS IT FRIDAY!?
-        
-        Args:
-            ctx (Any)
-        Returns:
-            None
         """
         try:
             today: datetime.datetime  = datetime.datetime.today()
@@ -1369,11 +1181,6 @@ class Misc(commands.Cog):
     async def isitflyday(self, ctx) -> None:
         """
         IS IT FLYDAY!?
-        
-        Args:
-            ctx (Any)
-        Returns:
-            None 
         """
         try:
             today: datetime.datetime = datetime.datetime.today()
@@ -1395,12 +1202,6 @@ class Misc(commands.Cog):
                  term: str) -> None:
         """
         Not sure what that term means?  UD prolly knows.
-        
-        Args:
-            ctx (Any)
-            term (str)
-        Returns:
-            None 
         """
         try:
             with ctx.channel.typing():
@@ -1421,12 +1222,6 @@ class Misc(commands.Cog):
     async def joint_context_menu(self, ctx, member: discord.Member) -> None:
         """
         Joint Context Menu
-        
-        Args:
-            ctx (Any)
-            member (discord.Member)
-        Returns:
-            None
         """
         strain: Optional[tuple] = await self.util.get_strain()
         if not strain:
@@ -1442,13 +1237,7 @@ class Misc(commands.Cog):
     @commands.user_command(name="Give Coffee")
     async def coffee_context_menu(self, ctx, member: discord.Member) -> None:
         """
-        Coffee Context Menu
-        
-        Args:
-            ctx (Any)
-            member (discord.Member)
-        Returns:
-            None       
+        Coffee Context Menu      
         """
         recipient_allergic: bool = False
         if member.id in [898332028007751741]:

cogs/owner.py

@@ -20,12 +20,6 @@ class Owner(commands.Cog):
     async def temperature(self, ctx, temp: Optional[int|str] = None) -> None:
         """
         Set Temperature
-        
-        Args:
-            ctx (Any): Discord context
-            temperature (Optional[int|str]): New temperature
-        Returns:
-            None
         """
         if not temp:
             return await ctx.respond(f"The current temperature is: {self._temperature} °C")
@@ -52,11 +46,6 @@ class Owner(commands.Cog):
                       ) -> None:
         """
         Edit a message previously sent by the bot
-        
-        Args:
-            ctx (Any): Discord context
-            msgid (str): Should be an int, the message id to edit
-            newcontent (str): Content to replace message with
         """
         
         try:
@@ -76,11 +65,6 @@ class Owner(commands.Cog):
     async def reload(self, ctx) -> None:
         """
         Reload Cogs
-        
-        Args:
-            ctx (Any): Discord context
-        Returns:
-            None
         """
         
         self.bot.load_exts(False)
@@ -93,12 +77,6 @@ class Owner(commands.Cog):
                   parameters: str) -> None:
         """
         Make me say something in a channel
-        
-        Args:
-            ctx (Any): Discord context
-            parameters (str): Channel <space> Message
-        Returns:
-            None
         """
         _parameters: list[str] = parameters.split(" ")
         
@@ -120,12 +98,6 @@ class Owner(commands.Cog):
                         status: Optional[str] = None) -> None:
         """
         Change bots status
-        
-        Args:
-            ctx (Any): Discord context
-            status (Optional[str]): The new status to set
-        Returns:
-            None
         """
         if not status:
             return await ctx.respond("ERR: No status provided to change to!",

cogs/radio.py

@@ -41,11 +41,6 @@ class Radio(commands.Cog):
     async def reinitradio(self, ctx) -> None:
         """
         Reinitialize serious.FM
-        
-        Args:
-            ctx (Any): Discord context
-        Returns:
-            None
         """
         loop: discord.asyncio.AbstractEventLoop = self.bot.loop
         loop.create_task(self.radio_init())
@@ -121,10 +116,6 @@ class Radio(commands.Cog):
     async def skip(self, ctx) -> None:
         """
         Skip - Convenience Command
-        Args:
-            ctx (Any)
-        Returns:
-            None
         """
         
         await skip()

cogs/sing.py

@@ -38,12 +38,6 @@ class Sing(commands.Cog):
                 song: Optional[str] = None) -> None:
         """
         Search for lyrics, format is artist : song.  Also reads activity.
-        
-        Args:
-            ctx (Any): Discord context
-            song (Optional[str]): Song to search
-        Returns:
-            None
         """
         try:
             with ctx.channel.typing():