From 631adc282f6a835fe7e9e8e3741c68497765789a Mon Sep 17 00:00:00 2001 From: TrustyJAID Date: Wed, 26 May 2021 03:23:46 -0600 Subject: [PATCH] [General] Fix usage in choose help (#5015) Co-authored-by: Draper <27962761+Drapersniper@users.noreply.github.com> --- docs/cog_guides/general.rst | 12 ++++++++---- redbot/cogs/general/general.py | 8 +++++--- 2 files changed, 13 insertions(+), 7 deletions(-) diff --git a/docs/cog_guides/general.rst b/docs/cog_guides/general.rst index 0fab5d769..782c82f90 100644 --- a/docs/cog_guides/general.rst +++ b/docs/cog_guides/general.rst @@ -62,18 +62,22 @@ choose .. code-block:: none - [p]choose [choices...] + [p]choose [others...] **Description** Choose between multiple options. +Options are separated by spaces. -.. note:: To denote options which include whitespace, you should use - double quotes. +.. note:: There must be at least 2 options to pick from. +.. note:: To denote options which include whitespace, you should enclose the option in double quotes. **Arguments** -* ``[choices...]``: The arguments for Red to randomly choose from. +* ````: The first mandatory option. +* ````: The second mandatory option. +* ``[others...]``: Any remaining optional options. + .. _general-command-flip: diff --git a/redbot/cogs/general/general.py b/redbot/cogs/general/general.py index 3d7061074..54593d0f1 100644 --- a/redbot/cogs/general/general.py +++ b/redbot/cogs/general/general.py @@ -80,12 +80,14 @@ class General(commands.Cog): """ Nothing to delete """ return - @commands.command(usage=" ") + @commands.command(usage=" [others...]") async def choose(self, ctx, *choices): """Choose between multiple options. - To denote options which include whitespace, you should use - double quotes. + There must be at least 2 options to pick from. + Options are separated by spaces. + + To denote options which include whitespace, you should enclose the options in double quotes. """ choices = [escape(c, mass_mentions=True) for c in choices if c] if len(choices) < 2: