From 86aff952f06f3526e020f48042a64acd72485aeb Mon Sep 17 00:00:00 2001 From: Kreusada <67752638+Kreusada@users.noreply.github.com> Date: Fri, 21 Oct 2022 20:03:56 +0100 Subject: [PATCH] Update `[p]helpset usemenus` documentation with converter changes (#5886) Co-authored-by: Kowlin <10947836+Kowlin@users.noreply.github.com> --- docs/cog_guides/core.rst | 20 +++++++++++--------- docs/framework_utils.rst | 2 +- 2 files changed, 12 insertions(+), 10 deletions(-) diff --git a/docs/cog_guides/core.rst b/docs/cog_guides/core.rst index 136d11fb8..8ebcc7cc8 100644 --- a/docs/cog_guides/core.rst +++ b/docs/cog_guides/core.rst @@ -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: diff --git a/docs/framework_utils.rst b/docs/framework_utils.rst index 74a6c03da..29a3b8447 100644 --- a/docs/framework_utils.rst +++ b/docs/framework_utils.rst @@ -36,7 +36,7 @@ Embed Helpers :exclude-members: randomize_color Menus -============== +===== .. automodule:: redbot.core.utils.menus :members: