Add note about missing itertools functions

maxfischer2781 · Dec 18, 2023 · b850383 · b850383
1 parent 83e06f8
commit b850383
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/docs/source/api/itertools.rst b/docs/source/api/itertools.rst
@@ -8,6 +8,12 @@ The itertools library
 The :py:mod:`asyncstdlib.itertools` library implements
 Python's :py:mod:`itertools` for (async) functions and (async) iterables.
 
+.. note::
+
+    Only functions which benefit from an explicit ``async`` implementation are provided.
+    Other functions from ``itertools`` can be turned asynchronous using :py:func:`~asyncstdlib.iter`,
+    e.g. `asyncstdlib.iter(itertools.count(5))`.
+
 .. note::
 
     To avoid leaking resources, all utilities in this module explicitly close their