aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorNadir Chowdhury <[email protected]>2021-04-10 19:59:09 +0100
committerGitHub <[email protected]>2021-04-10 14:59:09 -0400
commitb20e92efd8a6d84c87422f8f95f6aad23fde6011 (patch)
treec094c3d4ae5558c547ffbe140b29b2e75f199391 /docs
parent[commands] Minimise code duplication in channel converters (diff)
downloaddiscord.py-b20e92efd8a6d84c87422f8f95f6aad23fde6011.tar.xz
discord.py-b20e92efd8a6d84c87422f8f95f6aad23fde6011.zip
[docs] Fix references to Greedy
Diffstat (limited to 'docs')
-rw-r--r--docs/ext/commands/api.rst2
-rw-r--r--docs/ext/commands/commands.rst10
2 files changed, 6 insertions, 6 deletions
diff --git a/docs/ext/commands/api.rst b/docs/ext/commands/api.rst
index 9c1e3817..bd3f545f 100644
--- a/docs/ext/commands/api.rst
+++ b/docs/ext/commands/api.rst
@@ -323,7 +323,7 @@ Converters
.. autoclass:: discord.ext.commands.clean_content
:members:
-.. autoclass:: ext.commands.Greedy()
+.. autoclass:: discord.ext.commands.Greedy()
.. _ext_commands_api_errors:
diff --git a/docs/ext/commands/commands.rst b/docs/ext/commands/commands.rst
index 837e0044..c5ad3037 100644
--- a/docs/ext/commands/commands.rst
+++ b/docs/ext/commands/commands.rst
@@ -526,7 +526,7 @@ Note that ``typing.Literal[True]`` and ``typing.Literal[False]`` still follow th
Greedy
^^^^^^^^
-The :data:`~ext.commands.Greedy` converter is a generalisation of the :data:`typing.Optional` converter, except applied
+The :class:`~ext.commands.Greedy` converter is a generalisation of the :data:`typing.Optional` converter, except applied
to a list of arguments. In simple terms, this means that it tries to convert as much as it can until it can't convert
any further.
@@ -547,9 +547,9 @@ The type passed when using this converter depends on the parameter type that it
- Positional parameter types will receive either the default parameter or a :class:`list` of the converted values.
- Variable parameter types will be a :class:`tuple` as usual.
-- Keyword-only parameter types will be the same as if :data:`~ext.commands.Greedy` was not passed at all.
+- Keyword-only parameter types will be the same as if :class:`~ext.commands.Greedy` was not passed at all.
-:data:`~ext.commands.Greedy` parameters can also be made optional by specifying an optional value.
+:class:`~ext.commands.Greedy` parameters can also be made optional by specifying an optional value.
When mixed with the :data:`typing.Optional` converter you can provide simple and expressive command invocation syntaxes:
@@ -576,7 +576,7 @@ This command can be invoked any of the following ways:
.. warning::
- The usage of :data:`~ext.commands.Greedy` and :data:`typing.Optional` are powerful and useful, however as a
+ The usage of :class:`~ext.commands.Greedy` and :data:`typing.Optional` are powerful and useful, however as a
price, they open you up to some parsing ambiguities that might surprise some people.
For example, a signature expecting a :data:`typing.Optional` of a :class:`discord.Member` followed by a
@@ -586,7 +586,7 @@ This command can be invoked any of the following ways:
allowed through custom converters or reordering the parameters to minimise clashes.
To help aid with some parsing ambiguities, :class:`str`, ``None``, :data:`typing.Optional` and
- :data:`~ext.commands.Greedy` are forbidden as parameters for the :data:`~ext.commands.Greedy` converter.
+ :class:`~ext.commands.Greedy` are forbidden as parameters for the :class:`~ext.commands.Greedy` converter.
.. _ext_commands_error_handler: