From 6cda937ec232bca570999d28dc40b9e0ee88f7fe Mon Sep 17 00:00:00 2001 From: OofChair Date: Mon, 31 Oct 2022 00:06:32 -0400 Subject: [PATCH] [Modlog] Make `modlogset cases` docstring less vague (#5352) Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com> Co-authored-by: aikaterna <20862007+aikaterna@users.noreply.github.com> --- docs/cog_guides/core.rst | 10 +++++++--- redbot/core/core_commands.py | 8 +++++++- 2 files changed, 14 insertions(+), 4 deletions(-) diff --git a/docs/cog_guides/core.rst b/docs/cog_guides/core.rst index a549a54fa..2e99181f8 100644 --- a/docs/cog_guides/core.rst +++ b/docs/cog_guides/core.rst @@ -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: diff --git a/redbot/core/core_commands.py b/redbot/core/core_commands.py index 18a915ad0..25f772f19 100644 --- a/redbot/core/core_commands.py +++ b/redbot/core/core_commands.py @@ -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