diff options
| author | 2019-07-04 21:54:10 +0200 | |
|---|---|---|
| committer | 2019-07-04 21:54:10 +0200 | |
| commit | f089c963b39dabfa9ff2e776f7edc6e329a4bc54 (patch) | |
| tree | eaaac9f13e898aa75a04aa5f7e1c8c5b7105c372 | |
| parent | Replacing BigBrother by TalentPool in TalentPool docstrings (diff) | |
Applying docstring suggestions
Co-Authored-By: Mark <[email protected]>
| -rw-r--r-- | bot/cogs/watchchannels/bigbrother.py | 8 | ||||
| -rw-r--r-- | bot/cogs/watchchannels/talentpool.py | 8 |
2 files changed, 8 insertions, 8 deletions
diff --git a/bot/cogs/watchchannels/bigbrother.py b/bot/cogs/watchchannels/bigbrother.py index 20cc66012..e7b3d70bc 100644 --- a/bot/cogs/watchchannels/bigbrother.py +++ b/bot/cogs/watchchannels/bigbrother.py @@ -29,14 +29,14 @@ class BigBrother(WatchChannel): @group(name='bigbrother', aliases=('bb',), invoke_without_command=True) @with_role(Roles.owner, Roles.admin, Roles.moderator) async def bigbrother_group(self, ctx: Context) -> None: - """Monitors users by relaying their messages to the BigBrother watch channel.""" + """Monitors users by relaying their messages to the Big Brother watch channel.""" await ctx.invoke(self.bot.get_command("help"), "bigbrother") @bigbrother_group.command(name='watched', aliases=('all', 'list')) @with_role(Roles.owner, Roles.admin, Roles.moderator) async def watched_command(self, ctx: Context, update_cache: bool = True) -> None: """ - Shows the users that are currently being monitored in BigBrother. + Shows the users that are currently being monitored by Big Brother. The optional kwarg `update_cache` can be used to update the user cache using the API before listing the users. @@ -49,7 +49,7 @@ class BigBrother(WatchChannel): """ Relay messages sent by the given `user` to the `#big-brother` channel. - A `reason` for adding the user to BigBrother is required and will displayed + A `reason` for adding the user to Big Brother is required and will be displayed in the header when relaying messages of this user to the watchchannel. """ if user.bot: @@ -70,7 +70,7 @@ class BigBrother(WatchChannel): if response is not None: self.watched_users[user.id] = response - await ctx.send(f":white_check_mark: Messages sent by {user} will now be relayed to BigBrother.") + await ctx.send(f":white_check_mark: Messages sent by {user} will now be relayed to Big Brother.") @bigbrother_group.command(name='unwatch', aliases=('uw',)) @with_role(Roles.owner, Roles.admin, Roles.moderator) diff --git a/bot/cogs/watchchannels/talentpool.py b/bot/cogs/watchchannels/talentpool.py index d03ce0a7a..6f06ebc36 100644 --- a/bot/cogs/watchchannels/talentpool.py +++ b/bot/cogs/watchchannels/talentpool.py @@ -32,7 +32,7 @@ class TalentPool(WatchChannel): @group(name='talentpool', aliases=('tp', 'talent', 'nomination', 'n'), invoke_without_command=True) @with_role(Roles.owner, Roles.admin, Roles.moderator) async def nomination_group(self, ctx: Context) -> None: - """Highlights the activity of helper nominees by relaying their messages to TalentPool.""" + """Highlights the activity of helper nominees by relaying their messages to the talent pool channel.""" await ctx.invoke(self.bot.get_command("help"), "talentpool") @@ -40,7 +40,7 @@ class TalentPool(WatchChannel): @with_role(Roles.owner, Roles.admin, Roles.moderator) async def watched_command(self, ctx: Context, update_cache: bool = True) -> None: """ - Shows the users that are currently being monitored in TalentPool. + Shows the users that are currently being monitored in the talent pool. The optional kwarg `update_cache` can be used to update the user cache using the API before listing the users. @@ -53,7 +53,7 @@ class TalentPool(WatchChannel): """ Relay messages sent by the given `user` to the `#talent-pool` channel. - A `reason` for adding the user to TalentPool is required and will displayed + A `reason` for adding the user to the talent pool is required and will be displayed in the header when relaying messages of this user to the watchchannel. """ if user.bot: @@ -69,7 +69,7 @@ class TalentPool(WatchChannel): return if user.id in self.watched_users: - await ctx.send(":x: The specified user is already being watched in the TalentPool") + await ctx.send(":x: The specified user is already being watched in the talent pool") return # Manual request with `raise_for_status` as False because we want the actual response |