Skip to content

Commit 5d505bb

Browse files
committed
feature #4206 Added note about ProgressBar changes (kbond)
This PR was merged into the master branch. Discussion ---------- Added note about ProgressBar changes | Q | A | ------------- | --- | Doc fix? | no | New docs? | symfony/symfony#11852 | Applies to | 2.6 | Fixed tickets | n/a Commits ------- 4e2142d Added note about ProgressBar changes
2 parents 4198889 + 4e2142d commit 5d505bb

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

components/console/helpers/progressbar.rst

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,16 @@ you can also set the current progress by calling the
4646

4747
.. caution::
4848

49-
The progress bar only works if your platform supports ANSI codes; on other
50-
platforms, no output is generated.
49+
Prior to version 2.6, the progress bar only works if your platform
50+
supports ANSI codes; on other platforms, no output is generated.
51+
52+
.. versionadded:: 2.6
53+
If your platform doesn't support ANSI codes, updates to the progress
54+
bar are added as new lines. To prevent the output from being flooded,
55+
adjust the
56+
:method:`Symfony\\Component\\Console\\Helper\\ProgressBar::setRedrawFrequency`
57+
accordingly. By default, when using a ``max``, the redraw frequency
58+
is set to *10%* of your ``max``.
5159

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

0 commit comments

Comments
 (0)