Skip to content

Commit 4d170ca

Browse files
committed
Doc corrections
1 parent a2a3d99 commit 4d170ca

File tree

2 files changed

+19
-17
lines changed

2 files changed

+19
-17
lines changed

cogs/modmail.py

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
import asyncio
2-
import re
32
import os
43
from datetime import datetime
54
from typing import Optional, Union
@@ -177,7 +176,7 @@ async def snippets_remove(self, ctx, *, name: str.lower):
177176
@checks.thread_only()
178177
async def move(self, ctx, *, category: discord.CategoryChannel):
179178
"""
180-
Move a thread to a specified category.
179+
Move a thread to another category.
181180
182181
`category` may be a category ID, mention, or name.
183182
"""
@@ -268,12 +267,13 @@ async def close(self, ctx, *, after: UserFriendlyTime = None):
268267
@checks.thread_only()
269268
async def notify(self, ctx, *, role: Union[discord.Role, str.lower, None] = None):
270269
"""
271-
Notify a role or yourself to the next thread message received.
270+
Notify a role or yourself when the next thread message received.
272271
273-
Once a thread message is received `role` will only be pinged once.
272+
Once a thread message is received, `role` will only be pinged once.
274273
275-
Leave `role` empty to notify yourself. `@here` and `@everyone` can be substituted with `here` and `everyone`.
276-
`role` may be a role ID, mention, or name.
274+
Leave `role` empty to notify yourself.
275+
`@here` and `@everyone` can be substituted with `here` and `everyone`.
276+
`role` may be a role ID, mention, name, "everyone", or "here".
277277
"""
278278
thread = ctx.thread
279279

@@ -312,8 +312,9 @@ async def subscribe(self, ctx, *, role: Union[discord.Role, str.lower, None] = N
312312
313313
You will be pinged for every thread message received until you unsubscribe.
314314
315-
Leave `role` empty to notify yourself. `@here` and `@everyone` can be substituted with `here` and `everyone`.
316-
`role` may be a role ID, mention, or name.
315+
Leave `role` empty to subscribe yourself.
316+
`@here` and `@everyone` can be substituted with `here` and `everyone`.
317+
`role` may be a role ID, mention, name, "everyone", or "here".
317318
"""
318319
thread = ctx.thread
319320

@@ -350,10 +351,11 @@ async def subscribe(self, ctx, *, role: Union[discord.Role, str.lower, None] = N
350351
@checks.thread_only()
351352
async def unsubscribe(self, ctx, *, role=None):
352353
"""
353-
Unsubscribe a role yourself from a thread.
354+
Unsubscribe a role or yourself from a thread.
354355
355-
Leave `role` empty to notify yourself. `@here` and `@everyone` can be substituted with `here` and `everyone`.
356-
`role` may be a role ID, mention, or name.
356+
Leave `role` empty to unsubscribe yourself.
357+
`@here` and `@everyone` can be substituted with `here` and `everyone`.
358+
`role` may be a role ID, mention, name, "everyone", or "here".
357359
"""
358360
thread = ctx.thread
359361

@@ -492,7 +494,7 @@ async def logs_closed_by(self, ctx, *, user: User = None):
492494
"""
493495
Get all logs closed by the specified user.
494496
495-
If no `user` is provided, the user will be whoever sent this command.
497+
If no `user` is provided, the user will be the person who sent this command.
496498
`user` may be a user ID, mention, or name.
497499
"""
498500
user = user if user is not None else ctx.author
@@ -740,7 +742,7 @@ async def block(self, ctx, user: Optional[User] = None, *,
740742
"""
741743
Block a user from using Modmail.
742744
743-
You may chose to set a time as to when the user will automatically be unblocked.
745+
You may choose to set a time as to when the user will automatically be unblocked.
744746
745747
Leave `user` blank when this command is used within a
746748
thread channel to block the current recipient.

cogs/utility.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
from pkg_resources import parse_version
1212
from textwrap import indent
1313

14-
from discord import Embed, Color, Activity, Role, Member
14+
from discord import Embed, Color, Activity, Role
1515
from discord.enums import ActivityType, Status
1616
from discord.ext import commands
1717

@@ -287,7 +287,7 @@ async def debug(self, ctx):
287287
@checks.has_permissions(PermissionLevel.OWNER)
288288
@trigger_typing
289289
async def debug_hastebin(self, ctx):
290-
"""Stores application-logs to Hastebin."""
290+
"""Posts application-logs to Hastebin."""
291291

292292
haste_url = os.environ.get('HASTE_URL', 'https://hasteb.in')
293293

@@ -353,7 +353,7 @@ async def github(self, ctx):
353353
@trigger_typing
354354
async def update(self, ctx, *, flag: str = ''):
355355
"""
356-
Update bot.
356+
Update Modmail.
357357
358358
This only works for Heroku users who have configured their bot for updates.
359359
@@ -1015,7 +1015,7 @@ async def permissions_add_level(self, ctx, level: str, *,
10151015
invoke_without_command=True)
10161016
@checks.has_permissions(PermissionLevel.OWNER)
10171017
async def permissions_remove(self, ctx):
1018-
"""Remove a permission to use a command or permission level."""
1018+
"""Remove permission to use a command or permission level."""
10191019
await ctx.send_help(ctx.command)
10201020

10211021
@permissions_remove.command(name='command')

0 commit comments

Comments
 (0)