Skip to content

help

Refactored help system with separated concerns.

Modules:

  • components –

    UI components for the help command system.

  • data –

    Help system data management.

  • help –

    Simplified help command using refactored components.

  • navigation –

    Help system navigation and UI management.

  • renderer –

    Help system embed rendering.

  • utils –

    Utility functions for the help command system.

Classes:

  • TuxHelp –

    Simplified help command using separated components.

Classes

TuxHelp

Python
TuxHelp()

Bases: HelpCommand

Simplified help command using separated components.

Initialize the Tux help command.

Sets up the help command with standard attributes and aliases.

Methods:

Functions

_setup_components async
Python
_setup_components() -> tuple[HelpData, HelpRenderer, HelpNavigation]

Initialize help components and return them.

Returns:

send_bot_help async
Python
send_bot_help(mapping: Mapping[Cog | None, list[Command[Any, ..., Any]]]) -> None

Send the main help menu.

send_cog_help async
Python
send_cog_help(cog: Cog) -> None

Send help for a specific cog.

send_command_help async
Python
send_command_help(command: Command[Any, Any, Any]) -> None

Send help for a specific command.

send_group_help async
Python
send_group_help(group: Group[Any, Any, Any]) -> None

Send help for a command group.

send_error_message async
Python
send_error_message(error: str) -> None

Send an error message.