CopyBot/Red-DiscordBot
1
0
Fork 0
mirror of https://github.com/Cog-Creators/Red-DiscordBot.git synced 2025-11-07 11:48:55 -05:00
Code Issues Packages Projects Releases Wiki Activity

Fix descriptions for examples of ID-based command invocations in Mod (#5372)

Browse Source 
* Fix wording in redbot/cogs/mod/kickban.py to match with the command example

* Made changes as requested in PR Review #770078179

* Added changes to docs/cog_guides/mod.rst as requested in PR Review #70784066

* Fixed kick wording

* Fix kick wording
This commit is contained in:
WreckRox 2021-10-16 05:29:15 +06:00 committed by GitHub
parent 17dc9e0c47
commit 9aee8ce28f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/cog_guides/mod.rst
View File

@ -58,7 +58,7 @@ Ban a user from this server and optionally delete days of messages.
**Example Usage** **Example Usage**
* ``[p]ban 428675506947227648 7 Continued to spam after told to stop.`` * ``[p]ban 428675506947227648 7 Continued to spam after told to stop.``
This will ban Twentysix and it will delete 7 days worth of messages. This will ban the user with ID 428675506947227648 and it will delete 7 days worth of messages.
* ``[p]ban @Twentysix 7 Continued to spam after told to stop.`` * ``[p]ban @Twentysix 7 Continued to spam after told to stop.``
This will ban Twentysix and it will delete 7 days worth of messages. This will ban Twentysix and it will delete 7 days worth of messages.
@ -92,7 +92,7 @@ Kick a user.
**Example Usage** **Example Usage**
* ``[p]kick 428675506947227648 wanted to be kicked.`` * ``[p]kick 428675506947227648 wanted to be kicked.``
This will kick Twentysix from the server. This will kick the user with ID 428675506947227648 from the server.
* ``[p]kick @Twentysix wanted to be kicked.`` * ``[p]kick @Twentysix wanted to be kicked.``
This will kick Twentysix from the server. This will kick Twentysix from the server.
@ -642,7 +642,7 @@ Temporarily ban a user from this server.
* ``[p]tempban @Twentysix 15m You need a timeout`` * ``[p]tempban @Twentysix 15m You need a timeout``
This will ban Twentysix for 15 minutes. This will ban Twentysix for 15 minutes.
* ``[p]tempban 428675506947227648 1d2h15m 5 Evil person`` * ``[p]tempban 428675506947227648 1d2h15m 5 Evil person``
This will ban the user for 1 day 2 hours 15 minutes and will delete the last 5 days of their messages. This will ban the user with ID 428675506947227648 for 1 day 2 hours 15 minutes and will delete the last 5 days of their messages.
.. _mod-command-unban: .. _mod-command-unban:

6
redbot/cogs/mod/kickban.py
View File

@ -296,7 +296,7 @@ class KickBanMixin(MixinMeta):
Examples: Examples:
- `[p]kick 428675506947227648 wanted to be kicked.` - `[p]kick 428675506947227648 wanted to be kicked.`
This will kick Twentysix from the server. This will kick the user with ID 428675506947227648 from the server.
- `[p]kick @Twentysix wanted to be kicked.` - `[p]kick @Twentysix wanted to be kicked.`
This will kick Twentysix from the server. This will kick Twentysix from the server.
@ -382,7 +382,7 @@ class KickBanMixin(MixinMeta):
Examples: Examples:
- `[p]ban 428675506947227648 7 Continued to spam after told to stop.` - `[p]ban 428675506947227648 7 Continued to spam after told to stop.`
This will ban Twentysix and it will delete 7 days worth of messages. This will ban the user with ID 428675506947227648 and it will delete 7 days worth of messages.
- `[p]ban @Twentysix 7 Continued to spam after told to stop.` - `[p]ban @Twentysix 7 Continued to spam after told to stop.`
This will ban Twentysix and it will delete 7 days worth of messages. This will ban Twentysix and it will delete 7 days worth of messages.
@ -597,7 +597,7 @@ class KickBanMixin(MixinMeta):
- `[p]tempban @Twentysix 15m You need a timeout` - `[p]tempban @Twentysix 15m You need a timeout`
This will ban Twentysix for 15 minutes. This will ban Twentysix for 15 minutes.
- `[p]tempban 428675506947227648 1d2h15m 5 Evil person` - `[p]tempban 428675506947227648 1d2h15m 5 Evil person`
This will ban the user for 1 day 2 hours 15 minutes and will delete the last 5 days of their messages. This will ban the user with ID 428675506947227648 for 1 day 2 hours 15 minutes and will delete the last 5 days of their messages.
""" """
guild = ctx.guild guild = ctx.guild
author = ctx.author author = ctx.author