diff --git a/docs/cog_guides/cleanup.rst b/docs/cog_guides/cleanup.rst index 4a4233a0e..edc0fd468 100644 --- a/docs/cog_guides/cleanup.rst +++ b/docs/cog_guides/cleanup.rst @@ -294,3 +294,40 @@ Examples: - ```` The user whose messages are to be cleaned up. - ```` The max number of messages to cleanup. Must be a positive integer. - ```` Whether to delete pinned messages or not. Defaults to False + +.. _cleanup-command-cleanupset: + +^^^^^^^^^^ +cleanupset +^^^^^^^^^^ + +.. note:: |admin-lock| + +**Syntax** + +.. code-block:: none + + [p]cleanupset + +**Description** + +Manage the settings for the cleanup command. + +.. _cleanup-command-cleanupset-notify: + +""""""""""""""""" +cleanupset notify +""""""""""""""""" + +**Syntax** + +.. code-block:: none + + [p]cleanupset notify + +**Description** + +Toggle clean up notification settings. + +When enabled, a message will be sent per cleanup, showing how many messages were deleted. +This message will be deleted after 5 seconds. diff --git a/redbot/cogs/cleanup/cleanup.py b/redbot/cogs/cleanup/cleanup.py index 3ab1df1f9..cdbf01c0f 100644 --- a/redbot/cogs/cleanup/cleanup.py +++ b/redbot/cogs/cleanup/cleanup.py @@ -733,7 +733,11 @@ class Cleanup(commands.Cog): @cleanupset.command(name="notify") async def cleanupset_notify(self, ctx: commands.Context): - """Toggle clean up notification settings.""" + """Toggle clean up notification settings. + + When enabled, a message will be sent per cleanup, showing how many messages were deleted. + This message will be deleted after 5 seconds. + """ toggle = await self.config.guild(ctx.guild).notify() if toggle: await self.config.guild(ctx.guild).notify.set(False)