From 2b86d807e5d2df89ed2dcdf3665be674d527e15f Mon Sep 17 00:00:00 2001 From: Javier Eguiluz Date: Mon, 15 Dec 2014 19:01:49 +0100 Subject: [PATCH 1/2] Documented getProgress/setProgress methods --- components/console/helpers/progressbar.rst | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/components/console/helpers/progressbar.rst b/components/console/helpers/progressbar.rst index 627472eeff4..1138b5d03f8 100644 --- a/components/console/helpers/progressbar.rst +++ b/components/console/helpers/progressbar.rst @@ -42,7 +42,11 @@ number of units, and advance the progress as the command executes:: 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 -:method:`Symfony\\Component\\Console\\Helper\\ProgressBar::setCurrent` method. +:method:`Symfony\\Component\\Console\\Helper\\ProgressBar::setProgress` method. + +.. versionadded:: 2.6 + The ``setProgress()`` method was introduced in Symfony 2.6. Previously it was + called ``setCurrent()``. .. caution:: @@ -300,10 +304,14 @@ that displays the number of remaining steps:: ProgressBar::setPlaceholderFormatterDefinition( 'remaining_steps', function (ProgressBar $bar, OutputInterface $output) { - return $bar->getMaxSteps() - $bar->getStep(); + return $bar->getMaxSteps() - $bar->getProgress(); } ); +.. versionadded:: 2.6 + The ``getProgress()`` method was introduced in Symfony 2.6. Previously it was + called ``getStep()``. + Custom Messages ~~~~~~~~~~~~~~~ From 6a3cbd9541dca200cb0c9883f955376e1ec2d5c4 Mon Sep 17 00:00:00 2001 From: Javier Eguiluz Date: Tue, 16 Dec 2014 07:49:20 +0100 Subject: [PATCH 2/2] Changed the "new in Symfony 2.6" message for consistency --- components/console/helpers/progressbar.rst | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/components/console/helpers/progressbar.rst b/components/console/helpers/progressbar.rst index 1138b5d03f8..1b8edf309cc 100644 --- a/components/console/helpers/progressbar.rst +++ b/components/console/helpers/progressbar.rst @@ -45,8 +45,7 @@ you can also set the current progress by calling the :method:`Symfony\\Component\\Console\\Helper\\ProgressBar::setProgress` method. .. versionadded:: 2.6 - The ``setProgress()`` method was introduced in Symfony 2.6. Previously it was - called ``setCurrent()``. + The ``setProgress()`` method was called ``setCurrent()`` prior to Symfony 2.6. .. caution:: @@ -309,8 +308,7 @@ that displays the number of remaining steps:: ); .. versionadded:: 2.6 - The ``getProgress()`` method was introduced in Symfony 2.6. Previously it was - called ``getStep()``. + The ``getProgress()`` method was called ``getStep()`` prior to Symfony 2.6. Custom Messages ~~~~~~~~~~~~~~~