Merge pull request symfony#2588 from WouterJ/issue_2586

weaverryan · weaverryan · commit 9a85c1922afc · 2013-05-05T16:35:13.000-07:00
Documented setRedrawFrequenty()
diff --git a/components/console/helpers/progresshelper.rst b/components/console/helpers/progresshelper.rst
@@ -56,18 +56,20 @@ To see other available options, check the API documentation for
 
 .. caution::
 
-    For performance reasons, be careful to not set the total number of steps
-    to a high number. For example, if you're iterating over a large number
-    of items, consider a smaller "step" number that updates on only some
-    iterations::
+    For performance reasons, be careful if you set the total number of steps
+    to a high number. For example, if you're iterating over a large number of
+    items, consider setting the redraw frequency to a higher value by calling
+    :method:`Symfony\\Component\\Console\\Helper\\ProgressHelper::setRedrawFrequency`,
+    so it updates on only some iterations::
+
+        $progress->start($output, 50000);
+
+        // update every 100 iterations
+        $progress->setRedrawFrequency(100);
 
-        $progress->start($output, 500);
         $i = 0;
         while ($i++ < 50000) {
             // ... do some work
 
-            // advance every 100 iterations
-            if ($i % 100 == 0) {
-                $progress->advance();
-            }
-        }
+            $progress->advance();
+        }
