From 54dd72a42a3b6fe06a0450fb5d0aea5ebee638df Mon Sep 17 00:00:00 2001 From: TheManchineel <37479927+TheManchineel@users.noreply.github.com> Date: Sun, 1 Dec 2024 00:42:34 +0100 Subject: [PATCH] =?UTF-8?q?docs:=20=E2=9C=8D=EF=B8=8F=20add=20docstrings?= =?UTF-8?q?=20for=20campaign=20command=20functions?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- super_secret_santa/commands.py | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/super_secret_santa/commands.py b/super_secret_santa/commands.py index 028da62..75013c1 100644 --- a/super_secret_santa/commands.py +++ b/super_secret_santa/commands.py @@ -15,6 +15,7 @@ def setup(): @santa_command_group.command() async def create(ctx: discord.ext.commands.Context, campaign_name: str): + """Create a new Secret Santa campaign""" if not ctx.guild: await ctx.respond( "This command can only be used in a server!", @@ -64,6 +65,7 @@ async def create(ctx: discord.ext.commands.Context, campaign_name: str): @santa_command_group.command() async def delete(ctx: discord.ext.commands.Context): + """Delete the current Secret Santa campaign on the server""" if not ctx.guild: await ctx.respond( "This command can only be used in a server!", @@ -101,6 +103,7 @@ async def delete(ctx: discord.ext.commands.Context): @santa_command_group.command() async def message(ctx: discord.ext.commands.Context, message: str): + """Send a message to your giftee, whom you must get a gift for (NOT your Secret Santa)""" # we need to find out all started campaigns the Member is part of, where `giftee` is not NULL async with get_connection() as conn: cur = conn.cursor() @@ -162,6 +165,7 @@ async def message(ctx: discord.ext.commands.Context, message: str): # TODO: merge message and messagex @santa_command_group.command() async def messagex(ctx: discord.ext.commands.Context, number: int, message: str): + """Send a message to your giftee, whom you must get a gift for (NOT your Secret Santa)""" # we need to find out all started campaigns the Member is part of, where `giftee` is not NULL async with get_connection() as conn: cur = conn.cursor()