Merge pull request #2342 from fabpot/progress-helper

weaverryan · weaverryan · commit 7b06db8121b2 · 2013-03-25T04:14:34.000-07:00
added a note about the new setCurrent method on the progress helper
diff --git a/components/console/helpers/progresshelper.rst b/components/console/helpers/progresshelper.rst
@@ -7,6 +7,9 @@ Progress Helper
 .. versionadded:: 2.2
     The ``progress`` helper was added in Symfony 2.2.
 
+.. versionadded:: 2.3
+    The ``setCurrent`` method was added in Symfony 2.3.
+
 When executing longer-running commands, it may be helpful to show progress
 information, which updates as your command runs:
 
@@ -28,6 +31,12 @@ pass it a total number of units, and advance the progress as your command execut
 
     $progress->finish();
 
+.. tip::
+
+    You can also set the current progress by calling the
+    :method:`Symfony\\Component\\Console\\Helper\\ProgressHelper::setCurrent`
+    method.
+
 The appearance of the progress output can be customized as well, with a number
 of different levels of verbosity. Each of these displays different possible
 items - like percentage completion, a moving progress bar, or current/total
@@ -70,4 +79,4 @@ To see other available options, check the API documentation for
             if ($i % 100 == 0) {
                 $progress->advance();
             }
-        }
+        }
