[Console] Add documentation for the ProgressBar::iterate method

jvasseur · jvasseur · commit 9a72c24e6389 · 2019-01-30T21:47:06.000+01:00
diff --git a/components/console/helpers/progressbar.rst b/components/console/helpers/progressbar.rst
@@ -95,6 +95,23 @@ that the progress bar display is refreshed with a 100% completion.
     :method:`Symfony\\Component\\Console\\Helper\\ProgressBar::display`
     to show the progress bar again.
 
+If you want to use the progress bar to show the progress of an interation you can use the
+:method:`Symfony\\Component\\Console\\Helper\\ProgressBar::iterate` method that will automaticaly call ``start``,
+``advance`` and ``finish`` while iterating::
+
+    use Symfony\Component\Console\Helper\ProgressBar;
+
+    $progressBar = new ProgressBar($output);
+
+    // starts and displays the progress bar
+    foreach ($progressBar->iterate($iterable) as $key => $value) {
+        // ... do some work
+    }
+
+.. versionadded:: 4.3
+
+    The ``iterate`` method was introduced in Symfony 4.3.
+
 Customizing the Progress Bar
 ----------------------------
 
