From 1ed857d9093481387720ac1dc4041a64a2c9c593 Mon Sep 17 00:00:00 2001
From: vcokltfre <vcokltfre@gmail.com>
Date: Mon, 19 Apr 2021 20:20:48 +0100
Subject: chore: switch commands.Bot typehints to bot.bot's Bot

---
 bot/exts/evergreen/githubinfo.py | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

(limited to 'bot/exts/evergreen/githubinfo.py')

diff --git a/bot/exts/evergreen/githubinfo.py b/bot/exts/evergreen/githubinfo.py
index c8a6b3f7..da6eba5c 100644
--- a/bot/exts/evergreen/githubinfo.py
+++ b/bot/exts/evergreen/githubinfo.py
@@ -7,6 +7,7 @@ import discord
 from discord.ext import commands
 from discord.ext.commands.cooldowns import BucketType
 
+from bot.bot import Bot
 from bot.constants import Colours, NEGATIVE_REPLIES
 from bot.exts.utils.extensions import invoke_help_command
 
@@ -18,7 +19,7 @@ GITHUB_API_URL = "https://api.github.com"
 class GithubInfo(commands.Cog):
     """Fetches info from GitHub."""
 
-    def __init__(self, bot: commands.Bot):
+    def __init__(self, bot: Bot):
         self.bot = bot
 
     async def fetch_data(self, url: str) -> dict:
@@ -170,6 +171,6 @@ class GithubInfo(commands.Cog):
         await ctx.send(embed=embed)
 
 
-def setup(bot: commands.Bot) -> None:
+def setup(bot: Bot) -> None:
     """Adding the cog to the bot."""
     bot.add_cog(GithubInfo(bot))
-- 
cgit v1.2.3


From 713396a91859d914478e417ee6ab9e0a26ee6cf5 Mon Sep 17 00:00:00 2001
From: vcokltfre <vcokltfre@gmail.com>
Date: Mon, 19 Apr 2021 20:56:53 +0100
Subject: chore(evergreen): format each cog load docstring the same way

---
 bot/exts/evergreen/8bitify.py              | 2 +-
 bot/exts/evergreen/battleship.py           | 2 +-
 bot/exts/evergreen/conversationstarters.py | 2 +-
 bot/exts/evergreen/emoji.py                | 2 +-
 bot/exts/evergreen/error_handler.py        | 2 +-
 bot/exts/evergreen/fun.py                  | 2 +-
 bot/exts/evergreen/game.py                 | 2 +-
 bot/exts/evergreen/githubinfo.py           | 2 +-
 bot/exts/evergreen/issues.py               | 2 +-
 bot/exts/evergreen/magic_8ball.py          | 2 +-
 bot/exts/evergreen/movie.py                | 2 +-
 bot/exts/evergreen/ping.py                 | 2 +-
 bot/exts/evergreen/pythonfacts.py          | 2 +-
 bot/exts/evergreen/reddit.py               | 2 +-
 bot/exts/evergreen/space.py                | 2 +-
 bot/exts/evergreen/tic_tac_toe.py          | 2 +-
 bot/exts/evergreen/timed.py                | 2 +-
 bot/exts/evergreen/trivia_quiz.py          | 2 +-
 bot/exts/evergreen/uptime.py               | 2 +-
 bot/exts/evergreen/wikipedia.py            | 2 +-
 bot/exts/evergreen/xkcd.py                 | 2 +-
 21 files changed, 21 insertions(+), 21 deletions(-)

(limited to 'bot/exts/evergreen/githubinfo.py')

diff --git a/bot/exts/evergreen/8bitify.py b/bot/exts/evergreen/8bitify.py
index 621aa875..09a3eb5c 100644
--- a/bot/exts/evergreen/8bitify.py
+++ b/bot/exts/evergreen/8bitify.py
@@ -53,5 +53,5 @@ class EightBitify(commands.Cog):
 
 
 def setup(bot: Bot) -> None:
-    """Cog load."""
+    """Cog the EightBitify load."""
     bot.add_cog(EightBitify(bot))
diff --git a/bot/exts/evergreen/battleship.py b/bot/exts/evergreen/battleship.py
index f255afb9..ca0e3881 100644
--- a/bot/exts/evergreen/battleship.py
+++ b/bot/exts/evergreen/battleship.py
@@ -440,5 +440,5 @@ class Battleship(commands.Cog):
 
 
 def setup(bot: Bot) -> None:
-    """Cog load."""
+    """Load the Battleship cog"""
     bot.add_cog(Battleship(bot))
diff --git a/bot/exts/evergreen/conversationstarters.py b/bot/exts/evergreen/conversationstarters.py
index aed76bcf..04194c01 100644
--- a/bot/exts/evergreen/conversationstarters.py
+++ b/bot/exts/evergreen/conversationstarters.py
@@ -68,5 +68,5 @@ class ConvoStarters(commands.Cog):
 
 
 def setup(bot: Bot) -> None:
-    """Conversation starters Cog load."""
+    """Load the ConvoStarters cog."""
     bot.add_cog(ConvoStarters(bot))
diff --git a/bot/exts/evergreen/emoji.py b/bot/exts/evergreen/emoji.py
index 58d9be03..45b77e16 100644
--- a/bot/exts/evergreen/emoji.py
+++ b/bot/exts/evergreen/emoji.py
@@ -122,5 +122,5 @@ class Emojis(commands.Cog):
 
 
 def setup(bot: Bot) -> None:
-    """Add the Emojis cog into the bot."""
+    """Load the Emojis cog."""
     bot.add_cog(Emojis(bot))
diff --git a/bot/exts/evergreen/error_handler.py b/bot/exts/evergreen/error_handler.py
index 053e3866..64460822 100644
--- a/bot/exts/evergreen/error_handler.py
+++ b/bot/exts/evergreen/error_handler.py
@@ -137,5 +137,5 @@ class CommandErrorHandler(commands.Cog):
 
 
 def setup(bot: Bot) -> None:
-    """Error handler Cog load."""
+    """Load the ErrorHandler cog."""
     bot.add_cog(CommandErrorHandler(bot))
diff --git a/bot/exts/evergreen/fun.py b/bot/exts/evergreen/fun.py
index cde37895..c7b0d7d9 100644
--- a/bot/exts/evergreen/fun.py
+++ b/bot/exts/evergreen/fun.py
@@ -241,5 +241,5 @@ class Fun(Cog):
 
 
 def setup(bot: Bot) -> None:
-    """Fun Cog load."""
+    """Load the Fun cog."""
     bot.add_cog(Fun(bot))
diff --git a/bot/exts/evergreen/game.py b/bot/exts/evergreen/game.py
index 068d3f68..24872e76 100644
--- a/bot/exts/evergreen/game.py
+++ b/bot/exts/evergreen/game.py
@@ -471,7 +471,7 @@ class Games(Cog):
 
 
 def setup(bot: Bot) -> None:
-    """Add/Load Games cog."""
+    """Load the Games cog."""
     # Check does IGDB API key exist, if not, log warning and don't load cog
     if not Tokens.igdb_client_id:
         logger.warning("No IGDB client ID. Not loading Games cog.")
diff --git a/bot/exts/evergreen/githubinfo.py b/bot/exts/evergreen/githubinfo.py
index da6eba5c..65fcc7cf 100644
--- a/bot/exts/evergreen/githubinfo.py
+++ b/bot/exts/evergreen/githubinfo.py
@@ -172,5 +172,5 @@ class GithubInfo(commands.Cog):
 
 
 def setup(bot: Bot) -> None:
-    """Adding the cog to the bot."""
+    """Load the GithubInfo cog."""
     bot.add_cog(GithubInfo(bot))
diff --git a/bot/exts/evergreen/issues.py b/bot/exts/evergreen/issues.py
index 692e0b43..d7ee99c0 100644
--- a/bot/exts/evergreen/issues.py
+++ b/bot/exts/evergreen/issues.py
@@ -271,5 +271,5 @@ class Issues(commands.Cog):
 
 
 def setup(bot: Bot) -> None:
-    """Cog Retrieves Issues From Github."""
+    """Load the Issues cog."""
     bot.add_cog(Issues(bot))
diff --git a/bot/exts/evergreen/magic_8ball.py b/bot/exts/evergreen/magic_8ball.py
index 2dfe237a..61c68693 100644
--- a/bot/exts/evergreen/magic_8ball.py
+++ b/bot/exts/evergreen/magic_8ball.py
@@ -29,5 +29,5 @@ class Magic8ball(commands.Cog):
 
 
 def setup(bot: Bot) -> None:
-    """Magic 8ball Cog load."""
+    """Load the Magic8Ball cog."""
     bot.add_cog(Magic8ball(bot))
diff --git a/bot/exts/evergreen/movie.py b/bot/exts/evergreen/movie.py
index f4356f33..0d535b03 100644
--- a/bot/exts/evergreen/movie.py
+++ b/bot/exts/evergreen/movie.py
@@ -199,5 +199,5 @@ class Movie(Cog):
 
 
 def setup(bot: Bot) -> None:
-    """Load Movie Cog."""
+    """Load the Movie Cog."""
     bot.add_cog(Movie(bot))
diff --git a/bot/exts/evergreen/ping.py b/bot/exts/evergreen/ping.py
index 1332e3e6..71152d15 100644
--- a/bot/exts/evergreen/ping.py
+++ b/bot/exts/evergreen/ping.py
@@ -24,5 +24,5 @@ class Ping(commands.Cog):
 
 
 def setup(bot: Bot) -> None:
-    """Cog load."""
+    """Load the Ping cog."""
     bot.add_cog(Ping(bot))
diff --git a/bot/exts/evergreen/pythonfacts.py b/bot/exts/evergreen/pythonfacts.py
index bbc4eb17..1dd9b40d 100644
--- a/bot/exts/evergreen/pythonfacts.py
+++ b/bot/exts/evergreen/pythonfacts.py
@@ -30,5 +30,5 @@ class PythonFacts(commands.Cog):
 
 
 def setup(bot: Bot) -> None:
-    """Load PythonFacts Cog."""
+    """Load the PythonFacts Cog."""
     bot.add_cog(PythonFacts(bot))
diff --git a/bot/exts/evergreen/reddit.py b/bot/exts/evergreen/reddit.py
index ea77123e..ce22a864 100644
--- a/bot/exts/evergreen/reddit.py
+++ b/bot/exts/evergreen/reddit.py
@@ -125,5 +125,5 @@ class Reddit(commands.Cog):
 
 
 def setup(bot: Bot) -> None:
-    """Load the Cog."""
+    """Load the Reddit cog."""
     bot.add_cog(Reddit(bot))
diff --git a/bot/exts/evergreen/space.py b/bot/exts/evergreen/space.py
index 323ff659..b3f0016b 100644
--- a/bot/exts/evergreen/space.py
+++ b/bot/exts/evergreen/space.py
@@ -242,7 +242,7 @@ class Space(Cog):
 
 
 def setup(bot: Bot) -> None:
-    """Load Space Cog."""
+    """Load the Space cog."""
     if not Tokens.nasa:
         logger.warning("Can't find NASA API key. Not loading Space Cog.")
         return
diff --git a/bot/exts/evergreen/tic_tac_toe.py b/bot/exts/evergreen/tic_tac_toe.py
index 6e21528e..15cc1ef3 100644
--- a/bot/exts/evergreen/tic_tac_toe.py
+++ b/bot/exts/evergreen/tic_tac_toe.py
@@ -323,5 +323,5 @@ class TicTacToe(Cog):
 
 
 def setup(bot: Bot) -> None:
-    """Load TicTacToe Cog."""
+    """Load the TicTacToe cog."""
     bot.add_cog(TicTacToe(bot))
diff --git a/bot/exts/evergreen/timed.py b/bot/exts/evergreen/timed.py
index 35ca807c..42a77346 100644
--- a/bot/exts/evergreen/timed.py
+++ b/bot/exts/evergreen/timed.py
@@ -44,5 +44,5 @@ class TimedCommands(commands.Cog):
 
 
 def setup(bot: Bot) -> None:
-    """Cog load."""
+    """Load the Timed cog."""
     bot.add_cog(TimedCommands(bot))
diff --git a/bot/exts/evergreen/trivia_quiz.py b/bot/exts/evergreen/trivia_quiz.py
index 080f5b6f..f40375a6 100644
--- a/bot/exts/evergreen/trivia_quiz.py
+++ b/bot/exts/evergreen/trivia_quiz.py
@@ -301,5 +301,5 @@ class TriviaQuiz(commands.Cog):
 
 
 def setup(bot: Bot) -> None:
-    """Load the cog."""
+    """Load the TriviaQuiz cog."""
     bot.add_cog(TriviaQuiz(bot))
diff --git a/bot/exts/evergreen/uptime.py b/bot/exts/evergreen/uptime.py
index b8813bc7..c22af2c9 100644
--- a/bot/exts/evergreen/uptime.py
+++ b/bot/exts/evergreen/uptime.py
@@ -30,5 +30,5 @@ class Uptime(commands.Cog):
 
 
 def setup(bot: Bot) -> None:
-    """Uptime Cog load."""
+    """Load the Uptime cog."""
     bot.add_cog(Uptime(bot))
diff --git a/bot/exts/evergreen/wikipedia.py b/bot/exts/evergreen/wikipedia.py
index 068c4f43..e2172fc3 100644
--- a/bot/exts/evergreen/wikipedia.py
+++ b/bot/exts/evergreen/wikipedia.py
@@ -90,5 +90,5 @@ class WikipediaSearch(commands.Cog):
 
 
 def setup(bot: Bot) -> None:
-    """Wikipedia Cog load."""
+    """Load the WikipediaSearch cog."""
     bot.add_cog(WikipediaSearch(bot))
diff --git a/bot/exts/evergreen/xkcd.py b/bot/exts/evergreen/xkcd.py
index 1ff98ca2..ba9e46e0 100644
--- a/bot/exts/evergreen/xkcd.py
+++ b/bot/exts/evergreen/xkcd.py
@@ -87,5 +87,5 @@ class XKCD(Cog):
 
 
 def setup(bot: Bot) -> None:
-    """Loading the XKCD cog."""
+    """Load the XKCD cog."""
     bot.add_cog(XKCD(bot))
-- 
cgit v1.2.3


From 227d0a7705e08b74deb9b95ec4f643b1d0a0fcdd Mon Sep 17 00:00:00 2001
From: vcokltfre <vcokltfre@gmail.com>
Date: Mon, 19 Apr 2021 21:09:10 +0100
Subject: chore(evergreen): make usage of . at sentence ends consistent

---
 bot/exts/evergreen/battleship.py   |  6 +++---
 bot/exts/evergreen/bookmark.py     |  4 ++--
 bot/exts/evergreen/connect_four.py |  2 +-
 bot/exts/evergreen/emoji.py        |  2 +-
 bot/exts/evergreen/githubinfo.py   |  2 +-
 bot/exts/evergreen/minesweeper.py  | 10 +++++-----
 bot/exts/evergreen/wolfram.py      | 12 ++++++------
 7 files changed, 19 insertions(+), 19 deletions(-)

(limited to 'bot/exts/evergreen/githubinfo.py')

diff --git a/bot/exts/evergreen/battleship.py b/bot/exts/evergreen/battleship.py
index ca0e3881..813f998e 100644
--- a/bot/exts/evergreen/battleship.py
+++ b/bot/exts/evergreen/battleship.py
@@ -238,7 +238,7 @@ class Game:
         square = None
         turn_message = await self.turn.user.send(
             "It's your turn! Type the square you want to fire at. Format it like this: A1\n"
-            "Type `surrender` to give up"
+            "Type `surrender` to give up."
         )
         await self.next.user.send("Their turn", delete_after=3.0)
         while True:
@@ -382,7 +382,7 @@ class Battleship(commands.Cog):
             return await ctx.send("You're already playing a game!")
 
         if ctx.author in self.waiting:
-            return await ctx.send("You've already sent out a request for a player 2")
+            return await ctx.send("You've already sent out a request for a player 2.")
 
         announcement = await ctx.send(
             "**Battleship**: A new game is about to start!\n"
@@ -426,7 +426,7 @@ class Battleship(commands.Cog):
             self.games.remove(game)
         except Exception:
             # End the game in the event of an unforseen error so the players aren't stuck in a game
-            await ctx.send(f"{ctx.author.mention} {user.mention} An error occurred. Game failed")
+            await ctx.send(f"{ctx.author.mention} {user.mention} An error occurred. Game failed.")
             self.games.remove(game)
             raise
 
diff --git a/bot/exts/evergreen/bookmark.py b/bot/exts/evergreen/bookmark.py
index 329838b9..ec25e7a7 100644
--- a/bot/exts/evergreen/bookmark.py
+++ b/bot/exts/evergreen/bookmark.py
@@ -29,7 +29,7 @@ class Bookmark(commands.Cog):
         # Prevent users from bookmarking a message in a channel they don't have access to
         permissions = ctx.author.permissions_in(target_message.channel)
         if not permissions.read_messages:
-            log.info(f"{ctx.author} tried to bookmark a message in #{target_message.channel} but has no permissions")
+            log.info(f"{ctx.author} tried to bookmark a message in #{target_message.channel} but has no permissions.")
             embed = discord.Embed(
                 title=random.choice(ERROR_REPLIES),
                 color=Colours.soft_red,
@@ -52,7 +52,7 @@ class Bookmark(commands.Cog):
         except discord.Forbidden:
             error_embed = discord.Embed(
                 title=random.choice(ERROR_REPLIES),
-                description=f"{ctx.author.mention}, please enable your DMs to receive the bookmark",
+                description=f"{ctx.author.mention}, please enable your DMs to receive the bookmark.",
                 colour=Colours.soft_red
             )
             await ctx.send(embed=error_embed)
diff --git a/bot/exts/evergreen/connect_four.py b/bot/exts/evergreen/connect_four.py
index fbb13780..df2a913a 100644
--- a/bot/exts/evergreen/connect_four.py
+++ b/bot/exts/evergreen/connect_four.py
@@ -355,7 +355,7 @@ class ConnectFour(commands.Cog):
             self.games.remove(game)
         except Exception:
             # End the game in the event of an unforeseen error so the players aren't stuck in a game
-            await ctx.send(f"{ctx.author.mention} {user.mention if user else ''} An error occurred. Game failed")
+            await ctx.send(f"{ctx.author.mention} {user.mention if user else ''} An error occurred. Game failed.")
             if game in self.games:
                 self.games.remove(game)
             raise
diff --git a/bot/exts/evergreen/emoji.py b/bot/exts/evergreen/emoji.py
index 45b77e16..7ceb6c8d 100644
--- a/bot/exts/evergreen/emoji.py
+++ b/bot/exts/evergreen/emoji.py
@@ -87,7 +87,7 @@ class Emojis(commands.Cog):
         if not ctx.guild.emojis:
             await ctx.send("No emojis found.")
             return
-        log.trace(f"Emoji Category {'' if category_query else 'not '}provided by the user")
+        log.trace(f"Emoji Category {'' if category_query else 'not '}provided by the user.")
         for emoji in ctx.guild.emojis:
             emoji_category = emoji.name.split("_")[0]
 
diff --git a/bot/exts/evergreen/githubinfo.py b/bot/exts/evergreen/githubinfo.py
index 65fcc7cf..fd100a7c 100644
--- a/bot/exts/evergreen/githubinfo.py
+++ b/bot/exts/evergreen/githubinfo.py
@@ -96,7 +96,7 @@ class GithubInfo(commands.Cog):
 
                 embed.add_field(
                     name=f"Organization{'s' if len(orgs)!=1 else ''}",
-                    value=orgs_to_add if orgs else "No organizations"
+                    value=orgs_to_add if orgs else "No organizations."
                 )
             embed.add_field(name="Website", value=blog)
 
diff --git a/bot/exts/evergreen/minesweeper.py b/bot/exts/evergreen/minesweeper.py
index 7c1bac3b..bba349fa 100644
--- a/bot/exts/evergreen/minesweeper.py
+++ b/bot/exts/evergreen/minesweeper.py
@@ -38,7 +38,7 @@ class CoordinateConverter(commands.Converter):
     async def convert(self, ctx: commands.Context, coordinate: str) -> typing.Tuple[int, int]:
         """Take in a coordinate string and turn it into an (x, y) tuple."""
         if not 2 <= len(coordinate) <= 3:
-            raise commands.BadArgument('Invalid co-ordinate provided')
+            raise commands.BadArgument('Invalid co-ordinate provided.')
 
         coordinate = coordinate.lower()
         if coordinate[0].isalpha():
@@ -149,7 +149,7 @@ class Minesweeper(commands.Cog):
                 f"Close the game with `{Client.prefix}ms end`\n"
             )
         except discord.errors.Forbidden:
-            log.debug(f"{ctx.author.name} ({ctx.author.id}) has disabled DMs from server members")
+            log.debug(f"{ctx.author.name} ({ctx.author.id}) has disabled DMs from server members.")
             await ctx.send(f":x: {ctx.author.mention}, please enable DMs to play minesweeper.")
             return
 
@@ -159,7 +159,7 @@ class Minesweeper(commands.Cog):
         dm_msg = await ctx.author.send(f"Here's your board!\n{self.format_for_discord(revealed_board)}")
 
         if ctx.guild:
-            await ctx.send(f"{ctx.author.mention} is playing Minesweeper")
+            await ctx.send(f"{ctx.author.mention} is playing Minesweeper.")
             chat_msg = await ctx.send(f"Here's their board!\n{self.format_for_discord(revealed_board)}")
         else:
             chat_msg = None
@@ -248,7 +248,7 @@ class Minesweeper(commands.Cog):
         """
         Reveal one square.
 
-        return is True if the game ended, breaking the loop in `reveal_command` and deleting the game
+        return is True if the game ended, breaking the loop in `reveal_command` and deleting the game.
         """
         revealed[y][x] = board[y][x]
         if board[y][x] == "bomb":
@@ -286,7 +286,7 @@ class Minesweeper(commands.Cog):
         game = self.games[ctx.author.id]
         game.revealed = game.board
         await self.update_boards(ctx)
-        new_msg = f":no_entry: Game canceled :no_entry:\n{game.dm_msg.content}"
+        new_msg = f":no_entry: Game canceled. :no_entry:\n{game.dm_msg.content}"
         await game.dm_msg.edit(content=new_msg)
         if game.activated_on_server:
             await game.chat_msg.edit(content=new_msg)
diff --git a/bot/exts/evergreen/wolfram.py b/bot/exts/evergreen/wolfram.py
index c4c69070..c57a8d7a 100644
--- a/bot/exts/evergreen/wolfram.py
+++ b/bot/exts/evergreen/wolfram.py
@@ -56,7 +56,7 @@ def custom_cooldown(*ignore: List[int]) -> Callable:
     """
     Implement per-user and per-guild cooldowns for requests to the Wolfram API.
 
-    A list of roles may be provided to ignore the per-user cooldown
+    A list of roles may be provided to ignore the per-user cooldown.
     """
     async def predicate(ctx: Context) -> bool:
         if ctx.invoked_with == 'help':
@@ -189,11 +189,11 @@ class Wolfram(Cog):
             image_url = "attachment://image.png"
 
             if status == 501:
-                message = "Failed to get response"
+                message = "Failed to get response."
                 footer = ""
                 color = Colours.soft_red
             elif status == 400:
-                message = "No input found"
+                message = "No input found."
                 footer = ""
                 color = Colours.soft_red
             elif status == 403:
@@ -269,12 +269,12 @@ class Wolfram(Cog):
                 response_text = await response.text()
 
             if status == 501:
-                message = "Failed to get response"
+                message = "Failed to get response."
                 color = Colours.soft_red
             elif status == 400:
-                message = "No input found"
+                message = "No input found."
                 color = Colours.soft_red
-            elif response_text == "Error 1: Invalid appid":
+            elif response_text == "Error 1: Invalid appid.":
                 message = "Wolfram API key is invalid or missing."
                 color = Colours.soft_red
             else:
-- 
cgit v1.2.3