diff options
| author | 2019-07-04 22:01:15 +0200 | |
|---|---|---|
| committer | 2019-07-04 22:01:15 +0200 | |
| commit | a395ba657c582bee03beb334619f376ba4a43134 (patch) | |
| tree | 31caf1f09389cd6ce73fae2e7d4a1c449a728ffb | |
| parent | Applying docstring suggestions (diff) | |
Adding correct docstring to TalentPool edit group method; adding periods to docstrings in the WatchChannel ABC
| -rw-r--r-- | bot/cogs/watchchannels/talentpool.py | 2 | ||||
| -rw-r--r-- | bot/cogs/watchchannels/watchchannel.py | 8 |
2 files changed, 5 insertions, 5 deletions
diff --git a/bot/cogs/watchchannels/talentpool.py b/bot/cogs/watchchannels/talentpool.py index 6f06ebc36..d90bd2cbd 100644 --- a/bot/cogs/watchchannels/talentpool.py +++ b/bot/cogs/watchchannels/talentpool.py @@ -155,7 +155,7 @@ class TalentPool(WatchChannel): @nomination_group.group(name='edit', aliases=('e',), invoke_without_command=True) @with_role(Roles.owner, Roles.admin, Roles.moderator) async def nomination_edit_group(self, ctx: Context) -> None: - """Highlights the activity of helper nominees by relaying their messages to TalentPool.""" + """Commands to edit nominations.""" await ctx.invoke(self.bot.get_command("help"), "talentpool", "edit") diff --git a/bot/cogs/watchchannels/watchchannel.py b/bot/cogs/watchchannels/watchchannel.py index 87a219a96..fe6d6bb6e 100644 --- a/bot/cogs/watchchannels/watchchannel.py +++ b/bot/cogs/watchchannels/watchchannel.py @@ -224,7 +224,7 @@ class WatchChannel(ABC): ) async def relay_message(self, msg: Message) -> None: - """Relays the message to the relevant watch channel""" + """Relays the message to the relevant watch channel.""" limit = BigBrotherConfig.header_message_limit if ( @@ -272,7 +272,7 @@ class WatchChannel(ABC): self.message_history.message_count += 1 async def send_header(self, msg) -> None: - """Sends a header embed with information about the relayed messages to the watch channel""" + """Sends a header embed with information about the relayed messages to the watch channel.""" user_id = msg.author.id guild = self.bot.get_guild(GuildConfig.id) @@ -316,7 +316,7 @@ class WatchChannel(ABC): @staticmethod def _get_time_delta(time_string: str) -> str: - """Returns the time in human-readable time delta format""" + """Returns the time in human-readable time delta format.""" date_time = datetime.datetime.strptime( time_string, "%Y-%m-%dT%H:%M:%S.%fZ" @@ -334,7 +334,7 @@ class WatchChannel(ABC): return date_time.strftime(output_format) def _remove_user(self, user_id: int) -> None: - """Removes user from the WatchChannel""" + """Removes a user from a watch channel.""" self.watched_users.pop(user_id, None) self.message_queue.pop(user_id, None) self.consumption_queue.pop(user_id, None) |