Skip to content

Commit 2d762e5

Browse files
authored
Add note about missing itertools functions (#117)
1 parent 83e06f8 commit 2d762e5

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

docs/source/api/itertools.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,12 @@ The itertools library
88
The :py:mod:`asyncstdlib.itertools` library implements
99
Python's :py:mod:`itertools` for (async) functions and (async) iterables.
1010

11+
.. note::
12+
13+
Only functions which benefit from an explicit ``async`` implementation are provided.
14+
Other functions from ``itertools`` can be turned asynchronous using :py:func:`~asyncstdlib.iter`,
15+
e.g. `asyncstdlib.iter(itertools.count(5))`.
16+
1117
.. note::
1218

1319
To avoid leaking resources, all utilities in this module explicitly close their

0 commit comments

Comments
 (0)