Skip to content

Added note about ProgressBar changes #4206

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

Merged
merged 1 commit into from
Oct 3, 2014
Merged

Added note about ProgressBar changes #4206

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 10 additions & 2 deletions components/console/helpers/progressbar.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,16 @@ you can also set the current progress by calling the

.. caution::

The progress bar only works if your platform supports ANSI codes; on other
platforms, no output is generated.
Prior to version 2.6, the progress bar only works if your platform
supports ANSI codes; on other platforms, no output is generated.

.. versionadded:: 2.6
If your platform doesn't support ANSI codes, updates to the progress
bar are added as new lines. To prevent the output from being flooded,
adjust the
:method:`Symfony\\Component\\Console\\Helper\\ProgressBar::setRedrawFrequency`
accordingly. By default, when using a ``max``, the redraw frequency
is set to *10%* of your ``max``.

If you don't know the number of steps in advance, just omit the steps argument
when creating the :class:`Symfony\\Component\\Console\\Helper\\ProgressBar`
Expand Down