From 47193b63b0e6a5df02d12b34c68d8468f01328b3 Mon Sep 17 00:00:00 2001 From: Jakub Kuczys Date: Thu, 20 Apr 2023 00:37:12 +0200 Subject: [PATCH] [3.4] [Modlog] Make `modlogset cases` docstring less vague (#5352) (#6076) Co-authored-by: OofChair Co-authored-by: jack1142 <6032823+jack1142@users.noreply.github.com> Co-authored-by: aikaterna <20862007+aikaterna@users.noreply.github.com> --- docs/cog_guides/modlog.rst | 9 ++++++--- redbot/cogs/modlog/modlog.py | 6 +++++- 2 files changed, 11 insertions(+), 4 deletions(-) diff --git a/docs/cog_guides/modlog.rst b/docs/cog_guides/modlog.rst index 29f6faad4..167b95c8e 100644 --- a/docs/cog_guides/modlog.rst +++ b/docs/cog_guides/modlog.rst @@ -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: diff --git a/redbot/cogs/modlog/modlog.py b/redbot/cogs/modlog/modlog.py index a5545e3c8..2c1425fd1 100644 --- a/redbot/cogs/modlog/modlog.py +++ b/redbot/cogs/modlog/modlog.py @@ -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