Skip to content

Update ProgressBar docs with regress information #6949

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

Update ProgressBar docs with regress information #6949

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
18fe182
Update ProgressBar docs with regress information
Sep 2, 2016
c061370
Correct the regress ProgressBar docs
Sep 19, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions components/console/helpers/progressbar.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down