From 2f9ef514fb24b6a95bd3272885f197752810c107 Mon Sep 17 00:00:00 2001 From: Terry Jan Reedy Date: Sat, 20 Feb 2021 21:33:25 -0500 Subject: [PATCH] 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. --- Doc/reference/expressions.rst | 4 ++-- .../Documentation/2021-02-20-00-09-13.bpo-27646.HRsmo-.rst | 2 ++ 2 files changed, 4 insertions(+), 2 deletions(-) create mode 100644 Misc/NEWS.d/next/Documentation/2021-02-20-00-09-13.bpo-27646.HRsmo-.rst diff --git a/Doc/reference/expressions.rst b/Doc/reference/expressions.rst index c8c9b4683e6..17705b117c3 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 `` is used, it treats the supplied expression as -a subiterator. All values produced by that subiterator are passed directly +When ``yield from `` 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 00000000000..8ba398adf61 --- /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 ' works with any iterable, not just +iterators.