From 536be5796b78e08c26ab13e436ca8bb52e9ef04f Mon Sep 17 00:00:00 2001 From: Alexander Krause <44682073+Krause-a@users.noreply.github.com> Date: Fri, 5 Dec 2025 14:42:54 -0800 Subject: [PATCH] Fix Generator::rewind() docs to match actual behavior Clarify rewind() semantics to prevent misunderstandings about generator-specific behavior. --- language/predefined/generator/rewind.xml | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/language/predefined/generator/rewind.xml b/language/predefined/generator/rewind.xml index 3e028cd414f9..d3fd988b8e6c 100644 --- a/language/predefined/generator/rewind.xml +++ b/language/predefined/generator/rewind.xml @@ -3,7 +3,7 @@ Generator::rewind - Rewind the generator to the first yield + Execute the generator up to and including the first yield @@ -13,11 +13,11 @@ - The method rewinds the generator back to the point before the first &yield;. - If the generator is not at a first &yield; expression when this method is called, - it will first be let to advance to the first &yield; expression before rewinding. - If the generator has already at the point of beginning of the second &yield;, - this will throw an Exception. + Executes the generator up to and including the first &yield;. + If the generator is already at the first &yield;, + no action will be taken. + If the generator has ever advanced beyond a &yield; expression, + this method will throw an Exception.