mirror of
https://github.com/Cog-Creators/Red-DiscordBot.git
synced 2025-12-05 17:02:32 -05:00
Update [p]helpset usemenus documentation with converter changes (#5886)
Co-authored-by: Kowlin <10947836+Kowlin@users.noreply.github.com>
This commit is contained in:
@@ -1698,24 +1698,26 @@ helpset usemenus
|
|||||||
|
|
||||||
.. code-block:: none
|
.. code-block:: none
|
||||||
|
|
||||||
[p]helpset usemenus [use_menus]
|
[p]helpset usemenus <"buttons"|"reactions"|"select"|"selectonly"|"disable">
|
||||||
|
|
||||||
**Description**
|
**Description**
|
||||||
|
|
||||||
Allows the help command to be sent as a paginated menu instead of separate
|
Allows the help command to be sent as a paginated menu instead of separate
|
||||||
messages.
|
messages.
|
||||||
|
|
||||||
When enabled, ``[p]help`` will only show one page at a time and will use reactions to navigate between pages.
|
When "reactions", "buttons", "select", or "selectonly" is passed, ``[p]help`` will
|
||||||
|
only show one page at a time and will use the associated control scheme to navigate between pages.
|
||||||
|
|
||||||
This defaults to False.
|
**Examples:**
|
||||||
Using this without a setting will toggle.
|
- ``[p]helpset usemenus reactions`` - Enables using reaction menus.
|
||||||
|
- ``[p]helpset usemenus buttons`` - Enables using button menus.
|
||||||
**Examples:**
|
- ``[p]helpset usemenus select`` - Enables buttons with a select menu.
|
||||||
- ``[p]helpset usemenues True`` - Enables using menus.
|
- ``[p]helpset usemenus selectonly`` - Enables a select menu only on help.
|
||||||
- ``[p]helpset usemenues`` - Toggles the value.
|
- ``[p]helpset usemenus disable`` - Disables help menus.
|
||||||
|
|
||||||
**Arguments:**
|
**Arguments:**
|
||||||
- ``[use_menus]`` - Whether to use menus. Leave blank to toggle.
|
- ``<"buttons"|"reactions"|"select"|"selectonly"|"disable">`` - Whether to use ``buttons``,
|
||||||
|
``reactions``, ``select``, ``selectonly``, or no menus.
|
||||||
|
|
||||||
.. _core-command-helpset-usetick:
|
.. _core-command-helpset-usetick:
|
||||||
|
|
||||||
|
|||||||
@@ -36,7 +36,7 @@ Embed Helpers
|
|||||||
:exclude-members: randomize_color
|
:exclude-members: randomize_color
|
||||||
|
|
||||||
Menus
|
Menus
|
||||||
==============
|
=====
|
||||||
|
|
||||||
.. automodule:: redbot.core.utils.menus
|
.. automodule:: redbot.core.utils.menus
|
||||||
:members:
|
:members:
|
||||||
|
|||||||
Reference in New Issue
Block a user