Merge branch 'master' of https://github.com/verixx/modmail

Author: kyb3r

CHANGELOG.md

@@ -13,11 +13,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 # v2.6.3
 
-Fixed small issue in thread finding.
+Fixed small issue with finding thread.
 
 # v2.6.2
 
-Fixed log urls for selfhosting users. (This shouldn't affect anyone)
+Fixed log URLs for self-hosting users. 
+(This shouldn't affect anyone.)
 
 # v2.6.1
 
@@ -33,17 +34,19 @@ Mostly internal changes. Some are slightly breaking. Keep a lookout for broken f
 
 ### Changed
 - Log URLs are moved to their own collection.
-- Log URLs are now `https://logs.modmail.tk/LOGKEY`, no more numbers before the logkey.
-- We still support the numbers so as to not break everyone's urls so quickly but both work atm :p
+- Log URLs are now `https://logs.modmail.tk/LOGKEY`, no more numbers before the log key.
+- We still support the numbers so as to not break everyone's URLs so quickly but both work atm :p
 - This is a huge change to the backend logging and there might be migration errors. If so, please contact us at our [discord server](https://discord.gg/2fMbf2N)
 
 # v2.5.2
 
-Non-Breaking Internal Changes. (This shouldn't affect anyone.)
+Non breaking internal changes. 
+(This shouldn't affect anyone.)
 
 # v2.5.0
 
-Non-Breaking Internal Changes. (This shouldn't affect anyone.)
+Non breaking internal changes. 
+(This shouldn't affect anyone.)
 
 ### Background
 Bots hosted by Heroku restart at least once every 27 hours.
@@ -103,11 +106,11 @@ Breaking changes.
 
 ### Changed
 - Improved format for log channel embeds.
-- Roles are now comma separated in info embed.
+- Roles are now comma-separated in info embed.
 - This only applies to separate server setups.
 
 ### Fixed
-- Bug in subscribe command, it will now unsubscribe after a thread is closed.
+- Bug in subscribe command; it will now unsubscribe after a thread is closed.
 
 # v2.2.0
 
@@ -153,7 +156,7 @@ Breaking changes.
 - Use the `config set blocked_emoji` or `sent_emoji` commands.
 
 ### Quick Fix
-- Support multiple image and file attachments in one message.
+- Support multiple images and file attachments in one message.
 - This is only possible on mobile so its good to handle it in code.
 
 # v2.0.8
@@ -179,16 +182,16 @@ New command and improvements in bot update message interfaces.
 - Added a `changelog` command to view the bot's changelog within discord.
 
 ### Changed
-- Update command now shows latest changes directly from the [CHANGELOG.md](https://modmail.tk/) in the repo.
-- Auto update messages also show latest changes from repo.
-- Remove latest changes section from the `about` command.
+- `update` command now shows the latest changes directly from the [CHANGELOG.md](https://modmail.tk/) in the repo.
+- Auto update messages also show the latest changes from the GitHub repo.
+- Removed "latest changes" section from the `about` command.
 
 # v2.0.6
 
 ### Fixed
 - Fix logs sending duplicated thread close logs.
 - The bot will now tell you that a user is no longer in the server when you try to reply to a thread.
-    - Before this, it looked like you replied to the thread but in reality the message didnt get sent.
+    - Before this, it looked like you replied to the thread, but in reality, the message didn't get sent.
 
 # v2.0.5
 
@@ -199,15 +202,15 @@ New command and improvements in bot update message interfaces.
 # v2.0.4
 
 ### Fixed
-- Fixed a one off bug where the channel topic disappears, but modmail operations should still continue.
+- Fixed a one-off bug where the channel topic disappears, but modmail operations should still continue.
 - Fixed `linked_message_id` issues.
 
 # v2.0.3
 
 Fixed some issues with how data is displayed in the info embed.
 
 ### Fixed
-- Thread creation embed now shows the correct amount of past logs. 
+- Thread creation embed now shows the correct number of past logs. 
 - If using a separate server setup, roles in the info embed now are shown as names instead of mentions.
     - This is due to the fact that you can't mention roles across servers.
 

README.md

@@ -44,27 +44,27 @@ When a user sends a direct message to the bot, a channel is created within an is
 
 ## Installation
 
-You have two options for using this bot, hosting on Heroku or self hosting the bot. If you choose to install the bot using Heroku, you do not need to download anything. Read the installation guide [here](https://github.com/kyb3r/modmail/wiki/Installation) or watch the **[video tutorial](https://youtu.be/TH_1QfKUl_k)**. If you have any problems join our [discord server](https://discord.gg/etJNHCQ) or just join anyways :wink:
+You have two options for using this bot, host on Heroku or self-host the bot. If you choose to install the bot using Heroku, you do not need to download anything. Read the **[installation guide](https://github.com/kyb3r/modmail/wiki/Installation)** or watch the **[video tutorial](https://youtu.be/TH_1QfKUl_k)**. If you have any problems join our [discord server](https://discord.gg/etJNHCQ) or just join anyways :wink:
 
-## What is heroku?
+## What is Heroku?
 
-Heroku is a container based cloud platform that currently offers a free plan to host web apps. However, these apps have an ephemeral file system and thus cannot store any data on site. We have made Mod Mail to be accessible to anyone while still being feature rich, it's a community run project that lets anyone get it up and running 24/7 for free. So how does our bot store data? Config and logs are stored in a [centralised web service](https://modmail.tk) hosted by us. This enables you to get started easily and fast.
+Heroku is a container based cloud platform that currently offers a free plan to host web apps. However, these apps have an ephemeral file system and thus cannot store any data on site. We have made Modmail be accessible to anyone while still being feature-rich, it's a community run project that lets anyone get it up and running 24/7 for free. So how does our bot store data? Config and logs are stored in a [centralised web service](https://modmail.tk) hosted by us. This enables you to get started easily and fast.
 
-## Self hosted logs
+## Self-hosted logs
 
-If you want complete control over your data and do not want to use the centralised API service, you can self host your logs. You can do this by adding two config variables: 
+If you want complete control over your data and do not want to use the centralized API service, you can self host your logs. You can do this by adding two config variables: 
 
-* `MONGO_URI` - Mongodb connection URI, you can get a free 500mb cluster from [mongodb atlas](https://www.mongodb.com/cloud/atlas).
-* `LOG_URL` - The url of your log viewer heroku app (`https://yourlogviewerappname.herokuapp.com`)
+* `MONGO_URI` - MongoDB connection URI, you can get a free 500 MB cluster from [MongoDB Atlas](https://www.mongodb.com/cloud/atlas).
+* `LOG_URL` - The URL of your log viewer Heroku app (`https://yourlogviewerappname.herokuapp.com`)
 
-You also need to create a separate heroku app for the log viewer that you can deploy from [here](https://github.com/kyb3r/logviewer).
+You also need to create a separate Heroku app for the log viewer that you can deploy from [here](https://github.com/kyb3r/logviewer).
 
 ## Features and Commands
 The bot comes with a plethora of useful functionality. Take a look at the [list of commands](https://github.com/kyb3r/modmail/wiki/Features-and-commands).
 
 
 ### Automatic Updates
-The bot checks for new updates every hour and automatically updates to a newer version if found. This bot is under active development so you can always look forward to new, useful features! If you do not want this functionality, for example if you want to make changes to your fork, you can do so by adding a `disable_autoupdates` config variable. 
+The bot checks for new updates every hour and automatically updates to a newer version if found. This bot is under active development so you can always look forward to new, useful features! If you do not want this functionality, for example, if you want to make changes to your fork, you can do so by adding a `disable_autoupdates` config variable. 
 
 ## Contributing
 This project is licenced under MIT. If you have ideas for commands create an issue or pull request. Contributions are always welcome, whether it be documentation improvements or new functionality, please feel free to create a pull request.

app.json

@@ -1,6 +1,6 @@
 {
-  "name": "ModMail",
-  "description": "An easy to install ModMail bot for Discord - DM to contact mods!",
+  "name": "Modmail",
+  "description": "An easy to install Modmail bot for Discord - DM to contact mods!",
   "repository": "https://github.com/kyb3r/modmail",
   "env": {
     "TOKEN": {

bot.py

@@ -147,7 +147,7 @@ def main_category(self):
         if category_id is not None:
             return discord.utils.get(self.modmail_guild.categories, id=int(category_id))
         if self.modmail_guild:
-            return discord.utils.get(self.modmail_guild.categories, name='Mod Mail')
+            return discord.utils.get(self.modmail_guild.categories, name='Modmail')
 
     @property
     def blocked_users(self):

cogs/modmail.py

@@ -26,12 +26,12 @@ def obj(arg):
     @trigger_typing
     @commands.has_permissions(administrator=True)
     async def setup(self, ctx):
-        """Sets up a server for modmail"""
+        """Sets up a server for Modmail"""
         if self.bot.main_category:
             return await ctx.send(f'{self.bot.modmail_guild} is already set up.')
 
         categ = await self.bot.modmail_guild.create_category(
-            name='Mod Mail',
+            name='Modmail',
             overwrites=self.bot.overwrites(ctx)
         )
 
@@ -295,7 +295,7 @@ async def unsubscribe(self, ctx, *, role=None):
 
     @commands.command()
     async def nsfw(self, ctx):
-        """Flags a modmail thread as nsfw."""
+        """Flags a Modmail thread as nsfw."""
         thread = await self.bot.threads.find(channel=ctx.channel)
         if thread is None:
             return
@@ -306,7 +306,7 @@ async def nsfw(self, ctx):
     @commands.has_permissions(manage_messages=True)
     @trigger_typing
     async def logs(self, ctx, *, member: Union[discord.Member, discord.User, obj]=None):
-        """Shows a list of previous modmail thread logs of a member."""
+        """Shows a list of previous Modmail thread logs of a member."""
 
         if not member:
             thread = await self.bot.threads.find(channel=ctx.channel)
@@ -465,7 +465,7 @@ async def blocked(self, ctx):
     @trigger_typing
     @commands.has_permissions(manage_channels=True)
     async def block(self, ctx, user: Union[discord.Member, discord.User, obj]=None, *, reason=None):
-        """Block a user from using modmail."""
+        """Block a user from using Modmail."""
 
         if user is None:
             thread = await self.bot.threads.find(channel=ctx.channel)
@@ -499,7 +499,7 @@ async def block(self, ctx, user: Union[discord.Member, discord.User, obj]=None,
     @trigger_typing
     @commands.has_permissions(manage_channels=True)
     async def unblock(self, ctx, *, user: Union[discord.Member, discord.User, obj]=None):
-        """Unblocks a user from using modmail."""
+        """Unblocks a user from using Modmail."""
 
         if user is None:
             thread = await self.bot.threads.find(channel=ctx.channel)

cogs/utility.py

@@ -168,10 +168,10 @@ async def changelog(self, ctx):
     async def about(self, ctx):
         """Shows information about the bot."""
         em = discord.Embed(color=0x36393F, timestamp=datetime.datetime.utcnow())
-        em.set_author(name='Mod Mail - About', icon_url=self.bot.user.avatar_url)
+        em.set_author(name='Modmail - About', icon_url=self.bot.user.avatar_url)
         em.set_thumbnail(url=self.bot.user.avatar_url)
 
-        em.description = 'This is an open source discord bot that serves'\
+        em.description = 'This is an open source Discord bot that serves'\
                         ' as a means for members to easily communicate with'\
                         ' server leadership in an organised manner.'
 

core/thread.py

@@ -134,7 +134,7 @@ async def _close(self, closer, silent=False, delete_channel=True,
 
         em = discord.Embed(title='Thread Closed', color=discord.Color.red())
         em.description = message or \
-            f'{closer.mention} has closed this modmail thread.'
+            f'{closer.mention} has closed this Modmail thread.'
 
         if not silent and self.recipient is not None:
             tasks.append(self.recipient.send(embed=em))
@@ -315,7 +315,7 @@ def get_notifications(self):
 
 
 class ThreadManager:
-    """Class that handles storing, finding and creating modmail threads."""
+    """Class that handles storing, finding and creating Modmail threads."""
 
     def __init__(self, bot):
         self.bot = bot
@@ -396,7 +396,7 @@ async def _find_from_channel(self, channel):
             return thread
 
     async def create(self, recipient, *, creator=None, category=None):
-        """Creates a modmail thread"""
+        """Creates a Modmail thread"""
 
         em = discord.Embed(
             title='Thread created!',