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

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

Browse Source 
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:
OofChair 2022-10-31 00:06:32 -04:00 committed by GitHub
parent 0c35c9686b
commit 6cda937ec2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 14 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/cog_guides/core.rst
View File

@ -2350,11 +2350,15 @@ 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.
**Arguments:**
- ``[action]`` - The type of mod action to be enabled/disabled for case creation.
* ``[action]``: The action to enable or disable case creation for.
.. _core-command-modlogset-modlog:

8
redbot/core/core_commands.py
View File

@ -2291,7 +2291,13 @@ class Core(commands.commands._RuleDropper, commands.Cog, CoreLogic):
@modlogset.command(name="cases")
@commands.guild_only()
async def modlogset_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