From 9cfa39a1c79604d7854777a4e81855ade31829ec Mon Sep 17 00:00:00 2001 From: Rapptz Date: Sat, 29 Jul 2017 15:26:02 -0400 Subject: [PATCH] Fix AsyncIterator documentation to properly show coroutines. --- docs/api.rst | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/docs/api.rst b/docs/api.rst index f42e81f4d..8a3240afb 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -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. - .. method:: next() + .. comethod:: next() + + |coro| Advances the iterator by one, if possible. If no more items are found then this raises :exc:`NoMoreItems`. - .. method:: get(**attrs) + .. comethod:: get(**attrs) |coro| Similar to :func:`utils.get` except run over the async iterator. - .. method:: find(predicate) + .. comethod:: find(predicate) |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. :return: The first element that returns ``True`` for the predicate or ``None``. - .. method:: flatten() + .. comethod:: flatten() |coro|