CopyBot/Red-DiscordBot
1
0
Fork 0
mirror of https://github.com/Cog-Creators/Red-DiscordBot.git synced 2025-12-05 17:02:32 -05:00
Code Issues Packages Projects Releases Wiki Activity

[3.4] [Modlog] Make modlogset cases docstring less vague (#5352) (#6076)

Browse Source 
Co-authored-by: OofChair <oofchairr@gmail.com>
Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com>
Co-authored-by: aikaterna <20862007+aikaterna@users.noreply.github.com>
This commit is contained in:
Jakub Kuczys
2023-04-20 00:37:12 +02:00
committed by GitHub
parent dd9cf4da6e
commit 47193b63b0
2 changed files with 11 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
docs/cog_guides/modlog.rst
View File

@@ -120,11 +120,14 @@ modlogset cases
**Description**
Enable or disable case creation for a mod action.
Enable or disable case creation for a mod action, like disabling warnings, enabling bans, etc.
**Arguments**
**Examples:**
- ``[p]modlogset cases kick`` - Enables/disables modlog messages for kicks.
- ``[p]modlogset cases ban`` - Enables/disables modlog messages for bans.
* ``[action]``: The action to enable or disable case creation for.
**Arguments:**
- ``[action]`` - The type of mod action to be enabled/disabled for case creation.
.. _modlog-command-modlogset-modlog:

6
redbot/cogs/modlog/modlog.py
View File

@@ -72,7 +72,11 @@ class ModLog(commands.Cog):
@modlogset.command(name="cases")
@commands.guild_only()
async def set_cases(self, ctx: commands.Context, action: str = None):
"""Enable or disable case creation for a mod action."""
"""
Enable or disable case creation for a mod action.
An action can be enabling or disabling specific cases. (Ban, kick, mute, etc.)
Example: `[p]modlogset cases kick enabled`
"""
guild = ctx.guild
if action is None: # No args given