Update the help setup command.
build_develop / build (push) Successful in 37s
build_release / build (push) Successful in 21s

This commit is contained in:
2025-02-20 16:57:56 -05:00
parent ffc5c20fec
commit 9be9279239
+12 -22
View File
@@ -1,29 +1,21 @@
"""
Commands for helping a user.
"""
"""Commands for helping a user."""
import nextcord
from nextcord.ext import commands
class HelpCog(commands.Cog, name="Help commands."):
"""
Class holds commands for getting help.
"""
"""Class holds commands for getting help."""
def __init__(self) -> None:
"""
Default constructor for HelpCog class. Does nothing.
"""
"""Default constructor for HelpCog class. Does nothing."""
@nextcord.slash_command()
async def help(self, interaction: nextcord.Interaction):
"""
Parent slash command for help. Never called.
"""
"""Parent slash command for help. Never called."""
@help.subcommand(description="Describes how to get started with Agon.")
async def setup(self, interaction: nextcord.Interaction):
async def setup(self, interaction: nextcord.Interaction) -> None:
"""
Sends a message describing how to get started with Agon.
@@ -31,15 +23,13 @@ class HelpCog(commands.Cog, name="Help commands."):
interaction (nextcord.Interaction): Interaction that invoked the command.
"""
# I hate this but don't want indents in the string.
# pylint: disable=line-too-long
help_str: str = """Welcome to Agon! Three simple steps are needed to get started.
1.) Set a channel to recieve submission verifications with "/set verify_channel."
This channel is used to allow moderators to check if a submission is real/valid.
2.) Set a channel for submissions to be posted in with "/set submission_channel."
This channel will be where all user submission messages are sent.
3.) Set up your highscore tables! Use "/create group" to first create a group message in the channel you would like and then use "/create category" to create a category in that group message!"""
# pylint: enable=line-too-long
help_str: str = "Welcome to Agon! Three simple steps are needed to get started."
help_str += '1.) Set a channel to receive submission verifications with "/set verify_channel."\n'
help_str += "This channel is used to allow moderators to check if a submission is real/valid.\n\n"
help_str += '2.) Set up your highscore tables! Use "/create group" to first create a group message in the'
help_str += 'channel you would like and then use "/create category" to create a category in that group message!'
help_str += "\n\n"
help_str += '3.) Users can then submit scores with the "/submit" command.'
await interaction.response.send_message(content=help_str)