CopyBot/Red-DiscordBot
1
0
Fork 0
mirror of https://github.com/Cog-Creators/Red-DiscordBot.git synced 2025-11-07 03:38:53 -05:00
Code Issues Packages Projects Releases Wiki Activity

Update [p]helpset usemenus documentation with converter changes (#5886)

Browse Source 
Co-authored-by: Kowlin <10947836+Kowlin@users.noreply.github.com>
This commit is contained in:
Kreusada 2022-10-21 20:03:56 +01:00 committed by GitHub
parent 3be22b683c
commit 86aff952f0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 12 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
docs/cog_guides/core.rst
View File

@ -1698,24 +1698,26 @@ helpset usemenus
.. code-block:: none
[p]helpset usemenus [use_menus]
[p]helpset usemenus <"buttons"|"reactions"|"select"|"selectonly"|"disable">
**Description**
Allows the help command to be sent as a paginated menu instead of separate
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.
Using this without a setting will toggle.
**Examples:**
- ``[p]helpset usemenues True`` - Enables using menus.
- ``[p]helpset usemenues`` - Toggles the value.
**Examples:**
- ``[p]helpset usemenus reactions`` - Enables using reaction menus.
- ``[p]helpset usemenus buttons`` - Enables using button menus.
- ``[p]helpset usemenus select`` - Enables buttons with a select menu.
- ``[p]helpset usemenus selectonly`` - Enables a select menu only on help.
- ``[p]helpset usemenus disable`` - Disables help menus.
**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:

2
docs/framework_utils.rst
View File

@ -36,7 +36,7 @@ Embed Helpers
:exclude-members: randomize_color
Menus
==============
=====
.. automodule:: redbot.core.utils.menus
:members: