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

Specify that cleanup commands remove messages from current channel (#5070)

Browse Source
This commit is contained in:
jack1142 2021-05-23 16:24:17 +02:00 committed by GitHub
parent 820b21dccb
commit 7459af25ba
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/cog_guides/cleanup.rst
View File

@ -150,7 +150,7 @@ cleanup bot
**Description** **Description**
Clean up command messages and messages from the bot. Clean up command messages and messages from the bot in the current channel.
Can only cleanup custom commands and alias commands if those cogs are loaded. Can only cleanup custom commands and alias commands if those cogs are loaded.
@ -175,7 +175,7 @@ cleanup messages
**Description** **Description**
Delete the last X messages. Delete the last X messages in the current channel.
Example: Example:
- ``[p]cleanup messages 26`` - ``[p]cleanup messages 26``
@ -199,7 +199,7 @@ cleanup self
**Description** **Description**
Clean up messages owned by the bot. Clean up messages owned by the bot in the current channel.
By default, all messages are cleaned. If a second argument is specified, By default, all messages are cleaned. If a second argument is specified,
it is used for pattern matching - only messages containing the given text will be deleted. it is used for pattern matching - only messages containing the given text will be deleted.
@ -255,7 +255,7 @@ cleanup text
**Description** **Description**
Delete the last X messages matching the specified text. Delete the last X messages matching the specified text in the current channel.
Example: Example:
- ``[p]cleanup text "test" 5`` - ``[p]cleanup text "test" 5``
@ -283,7 +283,7 @@ cleanup user
**Description** **Description**
Delete the last X messages from a specified user. Delete the last X messages from a specified user in the current channel.
Examples: Examples:
- ``[p]cleanup user @Twentysix 2`` - ``[p]cleanup user @Twentysix 2``

10
redbot/cogs/cleanup/cleanup.py
View File

@ -151,7 +151,7 @@ class Cleanup(commands.Cog):
async def text( async def text(
self, ctx: commands.Context, text: str, number: positive_int, delete_pinned: bool = False self, ctx: commands.Context, text: str, number: positive_int, delete_pinned: bool = False
): ):
"""Delete the last X messages matching the specified text. """Delete the last X messages matching the specified text in the current channel.
Example: Example:
- `[p]cleanup text "test" 5` - `[p]cleanup text "test" 5`
@ -206,7 +206,7 @@ class Cleanup(commands.Cog):
async def user( async def user(
self, ctx: commands.Context, user: str, number: positive_int, delete_pinned: bool = False self, ctx: commands.Context, user: str, number: positive_int, delete_pinned: bool = False
): ):
"""Delete the last X messages from a specified user. """Delete the last X messages from a specified user in the current channel.
Examples: Examples:
- `[p]cleanup user @Twentysix 2` - `[p]cleanup user @Twentysix 2`
@ -435,7 +435,7 @@ class Cleanup(commands.Cog):
async def messages( async def messages(
self, ctx: commands.Context, number: positive_int, delete_pinned: bool = False self, ctx: commands.Context, number: positive_int, delete_pinned: bool = False
): ):
"""Delete the last X messages. """Delete the last X messages in the current channel.
Example: Example:
- `[p]cleanup messages 26` - `[p]cleanup messages 26`
@ -473,7 +473,7 @@ class Cleanup(commands.Cog):
async def cleanup_bot( async def cleanup_bot(
self, ctx: commands.Context, number: positive_int, delete_pinned: bool = False self, ctx: commands.Context, number: positive_int, delete_pinned: bool = False
): ):
"""Clean up command messages and messages from the bot. """Clean up command messages and messages from the bot in the current channel.
Can only cleanup custom commands and alias commands if those cogs are loaded. Can only cleanup custom commands and alias commands if those cogs are loaded.
@ -561,7 +561,7 @@ class Cleanup(commands.Cog):
match_pattern: str = None, match_pattern: str = None,
delete_pinned: bool = False, delete_pinned: bool = False,
): ):
"""Clean up messages owned by the bot. """Clean up messages owned by the bot in the current channel.
By default, all messages are cleaned. If a second argument is specified, By default, all messages are cleaned. If a second argument is specified,
it is used for pattern matching - only messages containing the given text will be deleted. it is used for pattern matching - only messages containing the given text will be deleted.