summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTerry Jan Reedy <tjreedy@udel.edu>2021-02-20 21:33:25 -0500
committerGitHub <noreply@github.com>2021-02-20 21:33:25 -0500
commit2f9ef514fb24b6a95bd3272885f197752810c107 (patch)
tree77654f6401b7288f925a08bd3e557ae39e973d5b
parentbf838a6e7eec2063a17c7c33dfa94afeef116f36 (diff)
downloadcpython-git-2f9ef514fb24b6a95bd3272885f197752810c107.tar.gz
bpo-27646: Say that 'yield from' expression can be any iterable (GH-24595)
Previously, the doc at least strongly implied that it had to be an iterator.
-rw-r--r--Doc/reference/expressions.rst4
-rw-r--r--Misc/NEWS.d/next/Documentation/2021-02-20-00-09-13.bpo-27646.HRsmo-.rst2
2 files changed, 4 insertions, 2 deletions
diff --git a/Doc/reference/expressions.rst b/Doc/reference/expressions.rst
index c8c9b4683e..17705b117c 100644
--- a/Doc/reference/expressions.rst
+++ b/Doc/reference/expressions.rst
@@ -478,8 +478,8 @@ allowing any pending :keyword:`finally` clauses to execute.
.. index::
single: from; yield from expression
-When ``yield from <expr>`` is used, it treats the supplied expression as
-a subiterator. All values produced by that subiterator are passed directly
+When ``yield from <expr>`` is used, the supplied expression must be an
+iterable. The values produced by iterating that iterable are passed directly
to the caller of the current generator's methods. Any values passed in with
:meth:`~generator.send` and any exceptions passed in with
:meth:`~generator.throw` are passed to the underlying iterator if it has the
diff --git a/Misc/NEWS.d/next/Documentation/2021-02-20-00-09-13.bpo-27646.HRsmo-.rst b/Misc/NEWS.d/next/Documentation/2021-02-20-00-09-13.bpo-27646.HRsmo-.rst
new file mode 100644
index 0000000000..8ba398adf6
--- /dev/null
+++ b/Misc/NEWS.d/next/Documentation/2021-02-20-00-09-13.bpo-27646.HRsmo-.rst
@@ -0,0 +1,2 @@
+Clarify that 'yield from <expr>' works with any iterable, not just
+iterators.