mirrors/discord.py
1
0
Fork 0
mirror of https://github.com/Rapptz/discord.py.git synced 2025-06-07 20:28:38 +00:00
Code Issues Projects Releases Wiki Activity

Fix AsyncIterator documentation to properly show coroutines.

Browse Source
This commit is contained in:
Rapptz 2017-07-29 15:26:02 -04:00
parent 51a39b5b1c
commit 9cfa39a1c7
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/api.rst
View File

@ -1267,18 +1267,20 @@ Certain utilities make working with async iterators easier, detailed below.
that this is only available in Python 3.5 or higher. that this is only available in Python 3.5 or higher.
.. method:: next() .. comethod:: next()
|coro|
Advances the iterator by one, if possible. If no more items are found Advances the iterator by one, if possible. If no more items are found
then this raises :exc:`NoMoreItems`. then this raises :exc:`NoMoreItems`.
.. method:: get(**attrs) .. comethod:: get(**attrs)
|coro| |coro|
Similar to :func:`utils.get` except run over the async iterator. Similar to :func:`utils.get` except run over the async iterator.
.. method:: find(predicate) .. comethod:: find(predicate)
|coro| |coro|
@ -1290,7 +1292,7 @@ Certain utilities make working with async iterators easier, detailed below.
:param predicate: The predicate to use. Can be a coroutine. :param predicate: The predicate to use. Can be a coroutine.
:return: The first element that returns ``True`` for the predicate or ``None``. :return: The first element that returns ``True`` for the predicate or ``None``.
.. method:: flatten() .. comethod:: flatten()
|coro| |coro|