8000 Update ProgressBar docs with regress information · jameshalsall/symfony-docs@18fe182 · GitHub
[go: up one dir, main page]

Skip to content

Commit 18fe182

Browse files
author
James Halsall
committed
Update ProgressBar docs with regress information
1 parent f78d06b commit 18fe182

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

components/console/helpers/progressbar.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,13 @@ number of units, and advance the progress as the command executes::
3535
// ensure that the progress bar is at 100%
3636
$progress->finish();
3737

38+
.. tip::
39+
40+
You can also regress the progress bar (i.e. step backwards) by using the
41+
``$progress->regress()`` method. Like the ``advance()`` method you can also
42+
pass a unit value to ``regress()`` to control how many steps the progress is
43+
regressed by.
44+
3845
Instead of advancing the bar by a number of steps (with the
3946
:method:`Symfony\\Component\\Console\\Helper\\ProgressBar::advance` method),
4047
you can also set the current progress by calling the

0 commit comments

Comments
 (0)
0