[Docs] Update Cleanup docs with new cleanupset command group (#5245)

* Add cleanupset commands to cleanup docs

* fix spacing

* shown -> sent

* update command docstring

* Fix trailing whitespace and use same style for docs

Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com>
This commit is contained in:
Kreus Amredes
2021-09-07 22:12:46 +01:00
committed by GitHub
parent 33dddaf5b4
commit 63fd7cc95f
2 changed files with 42 additions and 1 deletions

View File

@@ -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)