minor #10949 [Console] Add documentation for the ProgressBar::iterate method (jvasseur)

javiereguiluz · javiereguiluz · commit 1b77af853e5f · 2019-02-01T16:56:54.000+01:00
This PR was merged into the master branch. Discussion ---------- [Console] Add documentation for the ProgressBar::iterate method Doc PR for symfony/symfony#29753 Commits ------- 5c0b716 [Console] Add documentation for the ProgressBar::iterate method
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 iteration you can use the
+:method:`Symfony\\Component\\Console\\Helper\\ProgressBar::iterate` method that will automatically 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
 ----------------------------
 
