mirrors/discord.py
1
0
Fork 0
mirror of https://github.com/Rapptz/discord.py.git synced 2025-09-03 00:25:14 +00:00
Code Issues Projects Releases Wiki Activity

[commands] Make commands.Greedy a typing.Generic

Browse Source
This commit is contained in:
James
2021-04-10 12:27:32 +01:00
committed by GitHub
parent 4fee632526
commit bcd3a00eaf
3 changed files with 96 additions and 44 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
docs/ext/commands/api.rst
View File

@ -323,27 +323,7 @@ Converters
.. autoclass:: discord.ext.commands.clean_content
:members:
.. data:: ext.commands.Greedy
A special converter that greedily consumes arguments until it can't.
As a consequence of this behaviour, most input errors are silently discarded,
since it is used as an indicator of when to stop parsing.
When a parser error is met the greedy converter stops converting, undoes the
internal string parsing routine, and continues parsing regularly.
For example, in the following code:
.. code-block:: python3
@commands.command()
async def test(ctx, numbers: Greedy[int], reason: str):
await ctx.send(f"numbers: {numbers}, reason: {reason}")
An invocation of ``[p]test 1 2 3 4 5 6 hello`` would pass ``numbers`` with
``[1, 2, 3, 4, 5, 6]`` and ``reason`` with ``hello``\.
For more information, check :ref:`ext_commands_special_converters`.
.. autoclass:: ext.commands.Greedy()
.. _ext_commands_api_errors: