minor #9776 Documented the support of iterators in write() and writeln() (javiereguiluz)

javiereguiluz · javiereguiluz · commit 7dc019ef1ed4 · 2018-05-22T10:04:46.000+02:00
This PR was squashed before being merged into the 4.1 branch (closes #9776). Discussion ---------- Documented the support of iterators in write() and writeln() This fixes #9634. Commits ------- f9b9c10 Documented the support of iterators in write() and writeln()
diff --git a/console.rst b/console.rst
@@ -101,6 +101,10 @@ messages to the console)::
             '',
         ]);
 
+        // the value returned by someMethod() can be an iterator (https://secure.php.net/iterator)
+        // that generates and returns the messages with the 'yield' PHP keyword
+        $output->writeln($this->someMethod());
+
         // outputs a message followed by a "\n"
         $output->writeln('Whoa!');
 
@@ -109,6 +113,10 @@ messages to the console)::
         $output->write('create a user.');
     }
 
+.. versionadded:: 4.1
+    The support of PHP iterators in the ``write()`` and ``writeln()`` methods
+    was introduced in Symfony 4.1.
+
 Now, try executing the command:
 
 .. code-block:: terminal
