feature #6949 Update ProgressBar docs with regress information (jameshalsall)

xabbuh · xabbuh · commit cbe1aad586d4 · 2016-10-14T12:02:10.000+02:00
This PR was squashed before being merged into the master branch (closes #6949). Discussion ---------- Update ProgressBar docs with regress information Doc updates for changes introduced in symfony/symfony#19824 Commits ------- d3346d8 Update ProgressBar docs with regress information
diff --git a/components/console/helpers/progressbar.rst b/components/console/helpers/progressbar.rst
@@ -35,6 +35,12 @@ number of units, and advance the progress as the command executes::
     // ensure that the progress bar is at 100%
     $progress->finish();
 
+.. tip::
+
+    You can also regress the progress bar (i.e. step backwards) by calling
+    ``$progress->advance()`` with a negative value. For example, if you call
+    ``$progress->advance(-2)`` then it will regress the progress bar 2 steps.
+
 Instead of advancing the bar by a number of steps (with the
 :method:`Symfony\\Component\\Console\\Helper\\ProgressBar::advance` method),
 you can also set the current progress by calling the
